Webhooks

Atualizar webhook

Atualiza um webhook: qualquer subconjunto de name, url, active (false pausa as entregas sem apagar) e events. events SUBSTITUI a lista completa de assinaturas — lista vazia = não dispara nada; ”*” = todos; eventos que o provedor do número não emite são descartados. O número do webhook NÃO pode ser trocado pela API pública (400 NUMBER_RESCOPE_NOT_SUPPORTED) — apague e recrie. 404 se não for visível para a key. O segredo NUNCA é retornado.

PATCH

webhooks

{id}

Atualizar webhook

curl --request PATCH \
  --url https://pilotstatus.com.br/v1/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "active": false
}
'

{
  "id": "wh_01HZX...",
  "tenantId": "tenant_01HZX...",
  "name": "n8n",
  "url": "https://hooks.acme.com/whatsapp",
  "environment": "LIVE",
  "active": false,
  "events": [
    "message.received",
    "message.delivered"
  ],
  "createdAt": "2026-06-01T11:59:00.000Z",
  "updatedAt": "2026-07-03T12:05: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).

Parâmetros de caminho

string

obrigatório

Id do webhook.

Corpo

application/json

name

string

Novo nome de exibição.

Exemplo:

"n8n-prod"

url

string

Novo endpoint.

Exemplo:

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

active

boolean

false pausa as entregas; true retoma.

Exemplo:

"false"

events

string[]

Lista COMPLETA de substituição das assinaturas; "*" = todos.

Exemplo:

"[\"message.received\"]"

Resposta

Pausar entregas

Detalhar webhook

Excluir webhook

⌘I

Atualizar webhook

curl --request PATCH \
  --url https://pilotstatus.com.br/v1/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "active": false
}
'

{
  "id": "wh_01HZX...",
  "tenantId": "tenant_01HZX...",
  "name": "n8n",
  "url": "https://hooks.acme.com/whatsapp",
  "environment": "LIVE",
  "active": false,
  "events": [
    "message.received",
    "message.delivered"
  ],
  "createdAt": "2026-06-01T11:59:00.000Z",
  "updatedAt": "2026-07-03T12:05:00.000Z"
}