Skip to main content
POST
Create a WhatsApp webhook

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Scopes

whatsapp:write

Body

application/json

Attributes of the webhook to create.

Body of the request that creates a WhatsApp webhook.

url
string<uri>
required

An https URL whose host resolves only to public addresses. Webhooks of different groups can share a URL.

Maximum string length: 2048
Example:

"https://example.com/wavix"

group
enum<string>
required

Group of WhatsApp event types that a webhook receives. Your account can have one webhook per group. Possible values:

  • messages — Messages your senders receive, the delivery outcome of messages you send, and contacts' marketing preferences.
  • templates — Changes to the status, category, and quality rating of your templates.
  • senders — Changes to the status and quality rating of your senders.
Available options:
messages,
templates,
senders
Example:

"messages"

Response

The created WhatsApp webhook, including its secret.

A single WhatsApp webhook, returned when you create or retrieve a webhook.

webhook
WhatsAppWebhook · object
required

A WhatsApp webhook of your account, returned when you create, list, or retrieve a webhook.