Skip to main content
POST
Create Webhook

Basic Usage


Request Body


Response


Use type: "all" to receive every event type through a single webhook subscription.

Authorizations

Authorization
string
header
required

Bearer token for authentication. Format: Bearer YOUR_BEARER_TOKEN

Body

application/json
url
string
required

HTTPS endpoint to receive events

Example:

"https://your-server.com/webhook"

type
enum<string>
required

Event type to subscribe to

Available options:
message_received,
message_sent,
sent_message,
message_delivered,
message_read,
message_failed,
call,
all
Example:

"message_received"

platform
string

Platform (defaults to whatsapp)

Example:

"whatsapp"

Response

200 - application/json

Webhook created successfully

success
boolean
message
string
webhook
object