Skip to main content
POST
Cadastrar Webhook

Authorizations

Authorization
string
header
required

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

Body

application/json
integrationId
string
required

ID da integração

Pattern: ^c[a-z0-9]{24}$
url
string<uri>
required

URL do webhook

method
enum<string>
required

Método HTTP

Available options:
GET,
POST,
PUT,
DELETE,
PATCH
type
enum<string>
required

Tipo de evento que dispara o webhook

Available options:
MESSAGE_SENT_AND_RECEIVED,
MESSAGE_SENT,
MESSAGE_RECEIVED,
FIRST_MESSAGE_RECEIVED,
MESSAGE_IN_SERVICE,
CONNECTION_STATUS_UPDATE,
SERVICE_CONTINUITY_VERIFICATION
headers
object[]

Cabeçalhos HTTP adicionais

delayMinutes
integer

Atraso em minutos antes de disparar o webhook

Required range: x >= 0
transferType
enum<string>

Tipo de transferência para filtrar o disparo do webhook

Available options:
ALL,
USER,
AUTOMATION,
API,
AUTOMATION_AND_API

Response

Webhook cadastrado com sucesso

success
boolean
default:true

Indica se a operação foi bem-sucedida

response
object