Skip to main content
POST
Create webhook

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:
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