Skip to main content
POST
Crear la configuración de webhook

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Encabezados

x-company-id
string

Identificador de la empresa objetivo. Obligatorio solo para API keys globales (type=global). Se ignora para API keys de empresa y usuarios humanos.

Cuerpo

application/json
url
string<uri>
requerido

URL del webhook para recibir los eventos

events
enum<string>[]
requerido

Lista de eventos que dispararán el webhook

Minimum array length: 1
Opciones disponibles:
MESSAGE_SENT,
MESSAGE_RECEIVED,
MESSAGE_DELIVERED,
MESSAGE_READ,
CONVERSATION_UPDATED,
CONVERSATION_CREATED,
FOLLOWUP_SENT,
FIELD_UPDATED,
CONTACT_CREATED,
CONTACT_UPDATED
custom_headers
object

Headers personalizados para enviar junto con el webhook

status
enum<string>

Estado del webhook (ACTIVE o INACTIVE)

Opciones disponibles:
ACTIVE,
INACTIVE

Respuesta

_id
object
requerido
company
object
requerido
url
string
requerido
events
enum<string>[]
requerido
Opciones disponibles:
MESSAGE_SENT,
MESSAGE_RECEIVED,
MESSAGE_DELIVERED,
MESSAGE_READ,
CONVERSATION_UPDATED,
CONVERSATION_CREATED,
FOLLOWUP_SENT,
FIELD_UPDATED,
CONTACT_CREATED,
CONTACT_UPDATED
custom_headers
object
requerido
status
enum<string>
requerido
Opciones disponibles:
ACTIVE,
INACTIVE
createdAt
string<date-time>
updatedAt
string<date-time>