Pular para o conteúdo principal
POST
/
v1
/
webhooks
Criar webhook
curl --request POST \
  --url https://pilotstatus.com.br/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://hooks.acme.com/whatsapp",
  "name": "n8n",
  "events": [
    "message.received"
  ]
}
'
{
  "id": "wh_01HZX...",
  "tenantId": "tenant_01HZX...",
  "name": "n8n",
  "url": "https://hooks.acme.com/whatsapp",
  "environment": "LIVE",
  "active": true,
  "events": [
    "message.received"
  ],
  "createdAt": "2026-07-03T12:00:00.000Z",
  "updatedAt": "2026-07-03T12:00:00.000Z"
}

Autorizações

​
x-api-key
string
header
obrigatório

Sua chave de API ps_

Cabeçalhos

​
x-whatsapp-number-id
string

Restringe ao contexto de um número (obrigatório em concessões OAuth por número).

Corpo

application/json
​
url
string
obrigatório

Endpoint HTTPS que receberá os eventos.

Exemplo:

"https://hooks.acme.com/whatsapp"

​
name
string

Nome de exibição (padrão: hostname da URL).

Exemplo:

"n8n"

​
events
string[]

Eventos a assinar (ex.: ["message.received"]); "*" = todos. Vazio/omitido = não dispara nada.

Exemplo:

"[\"message.received\", \"message.delivered\"]"

​
whatsappNumberId
string

Número alvo — necessário só com key de tenant sem cabeçalho de número; com key de número deve coincidir com o escopo (400 NUMBER_MISMATCH).

Exemplo:

"num_01HZX..."

Resposta

Criar webhook