Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

Your API key (as_live_…), created under Settings → API keys.

Body

application/json
url
string
required

HTTPS endpoint to POST events to.

Example:

"https://example.com/hooks/verbose"

events
enum<string>[]

Omit for all events.

Available options:
message.received,
message.delivered,
message.failed,
contact.opted_out,
link.clicked,
conversion.recorded,
call.completed

Response

One webhook.

ok
boolean
Example:

true

webhook
object

A webhook subscription.