Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-08-0610636149.4 KB
Webhooks

Crear webhook

Crea una nueva suscripción de webhook. Cliengo enviará un POST a la URL indicada cada vez que ocurra uno de los eventos seleccionados. El webhook se crea activo por defecto y se le asigna un secret que se enviará en el header X-Webhook-Secret de cada entrega para verificar autenticidad.

post/v1/webhooks

Request body

urlstring uri required

URL donde Cliengo enviará los eventos via POST

eventTypesWebhookEventType[] required

Eventos a los que suscribirse (al menos uno)

websiteIdstring

ID del canal. Usar * o omitir para recibir eventos de todos los canales

retryCountinteger

Reintentos en caso de fallo (0 = sin reintentos, máximo 10)

customHeadersobject

Headers extra a incluir en cada entrega

Example request

{
  "url": "https://tu-servidor.com/webhook",
  "eventTypes": [
    "conversation/created",
    "conversation/message"
  ]
}

Response

Webhook creado

idstring

ID de la suscripción.

companyIdstring

ID de la empresa dueña de la suscripción.

websiteIdstring

ID del canal o * para todos los canales

urlstring uri
eventTypesWebhookEventType[]
isActiveboolean
secretstring

Token secreto enviado en el header X-Webhook-Secret de cada entrega

retryCountinteger

Cantidad máxima de reintentos en caso de fallo (backoff exponencial)

customHeadersobject

Headers personalizados enviados con cada entrega

createdAtstring date-time

Fecha de creación de la suscripción.

updatedAtstring date-time

Fecha de última modificación.

Example response

{
  "id": "60a1b2c3d4e5f6a7b8c9d0e1",
  "websiteId": "*",
  "url": "https://tu-servidor.com/webhook",
  "eventTypes": [
    "conversation/created",
    "contact/created"
  ],
  "isActive": true,
  "secret": "whsec_aBcDeFgHiJkLmNoPqRsTuVwXyZ123456",
  "retryCount": 5,
  "customHeaders": {
    "X-Custom-Key": "valor"
  }
}