Saltar al contenido
Referencia de API
/
Recursos compartidos
/
/Webhooks

Webhooks

API para la configuración del webhook del equipo.

Operations

Configurar el webhook del equipo

Request

Crea o reemplaza la configuración de webhook del equipo.

  • Requisitos previos: callbackUrl debe ser una URL HTTPS de 1 a 1024 caracteres, con host, sin información de usuario, sin fragmento y con un puerto válido. Todas las direcciones a las que resuelva deben ser enrutables públicamente; se rechazan los rangos de localhost, privados, link-local, CGNAT, metadatos de nube, reservados por protocolo, de documentación y 6to4. La misma comprobación se repite cuando una entrega abre su conexión, así que un nombre que más tarde resuelva a un rango privado hace fallar esa entrega en lugar de llegar a tu red.
  • Efecto: hace un upsert de la única configuración del equipo del contexto del servidor. teamId nunca se lee de la petición, así que quien llama no puede configurar otro equipo. Los endpoints de la Local API y la Open API leen y escriben el mismo registro, y la respuesta refleja lo que se almacenó.
  • Desactivación: enabled: false mantiene la URL y detiene la creación de nuevos eventos. Los eventos ya en cola se cancelan uno a uno si la configuración sigue desactivada cuando les toca autorizarse, así que reactivarla pronto permite que continúen.
  • Reintento: seguro. El guardado es un upsert por equipo, así que repetir la misma petición converge en el mismo estado.
  • Versión del cliente: requiere el cliente de MoreLogin v2.66.0 o superior, porque es el cliente de escritorio el que expone esta ruta en local. El endpoint de la Open API no depende del cliente.

Consulta Webhooks para el contrato de callback, los nombres de evento y el calendario de reintentos.

Errores de negocio documentados: 41001. Consulte Error Codes para el significado de cada código. Cualquier operación puede devolver además los códigos comunes.

Bodyapplication/json
callbackUrlstring, <= 1024 charactersrequired

URL HTTPS que recibe los eventos. De 1 a 1024 caracteres.

enabledbooleanrequired

Indica si la entrega está activada para el equipo.

POST
/api/webhook/config
curl -i -X POST \
  http://127.0.0.1:40000/api/webhook/config \
  -H 'Content-Type: application/json' \
  -d '{
    "callbackUrl": "https://example.com/morelogin/webhook",
    "enabled": true
  }'

Responses

Correcto. data es un objeto con los campos callbackUrl y enabled que refleja la configuración almacenada.

Headers
any
Bodyapplication/json
codeintegerrequired

Código de resultado. 0 indica éxito; otros códigos indican excepciones.

msgstring or nullrequired

Mensaje de error

dataobjectrequired
requestIdstringrequired

ID de solicitud de la operación

Response
{
  "code": 0,
  "msg": "",
  "data": {
    "callbackUrl": "https://example.com/morelogin/webhook",
    "enabled": true
  },
  "requestId": ""
}