Webhooks

Create webhook

Creates a webhook subscribed to ONE WhatsApp number. The number comes from the key scope (number key), the x-whatsapp-number-id header or the whatsappNumberId body field — if the body contradicts the key scope → 400 NUMBER_MISMATCH; no resolvable number → 400 NUMBER_REQUIRED; another tenant’s number → 404 NUMBER_NOT_FOUND. events picks what gets delivered: an empty/omitted list dispatches NOTHING (there is no implicit “subscribe to all”; use ”*” for all) and events the number’s provider cannot emit are silently dropped. The signing secret is NEVER returned.

POST

webhooks

Create 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"
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Headers

x-whatsapp-number-id

string

Scopes to a single number (required for per-number OAuth grants).

Body

application/json

url

string

required

HTTPS endpoint that will receive the events.

Example:

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

name

string

Display name (default: the URL hostname).

Example:

"n8n"

events

string[]

Events to subscribe to (e.g. ["message.received"]); "*" = all. Empty/omitted = dispatches nothing.

Example:

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

whatsappNumberId

string

Target number — only needed with a tenant key and no number header; with a number key it must match the scope (400 NUMBER_MISMATCH).

Example:

"num_01HZX..."

Response

Create webhook

List webhooks

Get webhook

⌘I

Create 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"
}