Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-08-0610636149.4 KB
Webhooks

Actualizar webhook

Actualiza la configuración de un webhook existente. Solo se modifican los campos enviados en el body; los demás se mantienen sin cambios.

put/v1/webhooks/{webhookId}

Path parameters

webhookIdstring required

ID del webhook

Request body

urlstring uri

Nueva URL de destino.

eventTypesWebhookEventType[]

Nueva lista de eventos a los que suscribirse.

isActiveboolean

Activar o pausar la suscripción.

retryCountinteger

Nueva cantidad máxima de reintentos.

customHeadersobject

Nuevos headers personalizados para cada entrega.

Response

Webhook actualizado

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"
  }
}