Skip to main content
POST
Criar configuração de webhook

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Corpo

application/json
url
string<uri>
obrigatório

URL do webhook para receber os eventos

events
enum<string>[]
obrigatório

Lista de eventos que dispararão o webhook

Minimum array length: 1
Opções disponíveis:
MESSAGE_SENT,
MESSAGE_RECEIVED,
CONVERSATION_UPDATED,
CONVERSATION_CREATED,
FOLLOWUP_SENT,
FIELD_UPDATED,
CONTACT_CREATED,
CONTACT_UPDATED
custom_headers
object

Headers customizados para enviar junto com o webhook

status
enum<string>

Status do webhook (ACTIVE ou INACTIVE)

Opções disponíveis:
ACTIVE,
INACTIVE

Resposta

201 - application/json
_id
object
obrigatório
company
object
obrigatório
url
string
obrigatório
events
enum<string>[]
obrigatório
Opções disponíveis:
MESSAGE_SENT,
MESSAGE_RECEIVED,
CONVERSATION_UPDATED,
CONVERSATION_CREATED,
FOLLOWUP_SENT,
FIELD_UPDATED,
CONTACT_CREATED,
CONTACT_UPDATED
custom_headers
object
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
ACTIVE,
INACTIVE
createdAt
string<date-time>
updatedAt
string<date-time>