Skip to main content
POST
/
v1
/
webhooks
Criar configuração de webhook
curl --request POST \
  --url https://api.nuvia.ai/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [],
  "custom_headers": {}
}
'
{
  "_id": {},
  "company": {},
  "url": "<string>",
  "events": [],
  "custom_headers": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Token JWT de autenticação

Headers

​
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.

Body

application/json
​
url
string<uri>
required

URL do webhook para receber os eventos

​
events
enum<string>[]
required

Lista de eventos que dispararão o webhook

Minimum array length: 1
Available options:
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)

Available options:
ACTIVE,
INACTIVE

Response

201 - application/json
​
_id
object
required
​
company
object
required
​
url
string
required
​
events
enum<string>[]
required
Available options:
MESSAGE_SENT,
MESSAGE_RECEIVED,
CONVERSATION_UPDATED,
CONVERSATION_CREATED,
FOLLOWUP_SENT,
FIELD_UPDATED,
CONTACT_CREATED,
CONTACT_UPDATED
​
custom_headers
object
required
​
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
​
createdAt
string<date-time>
​
updatedAt
string<date-time>