Create webhook
Creates a webhook endpoint subscribed to one or more event topics. The signing secret is returned only in this response — store it to verify delivery…
POST/v2/api/webhooks
Creates a webhook endpoint subscribed to one or more event topics.
url must be a publicly reachable HTTPS URL.
topics must contain at least one valid event type. Unknown topics return a 400 with code INVALID_EVENT_TYPE.
- The
signing_secret is returned only in this response. Store it to verify signatures.
Authorization
Authorizationstring · headerrequired
Api-Key ak_live_…
Body
urlstring<uri>required
HTTPS URL that will receive event deliveries.
topicsenum<string>[]required
Event topics to subscribe to (at least one).
call.receivedcall.triggeredcall.answeredcall.completedtag.addedtag.removedsms.receivedsms.sentcontact.createdcontact.updatedsummary.updated
descriptionstring
Optional human-readable label.
Responses
201Webhook created
dataobject
A webhook endpoint.
7 fields
idstring
Unique webhook endpoint ID.
urlstring<uri>
HTTPS URL that receives event deliveries.
topicsenum<string>[]
Event topics this endpoint is subscribed to.
call.receivedcall.triggeredcall.answeredcall.completedtag.addedtag.removedsms.receivedsms.sentcontact.createdcontact.updatedsummary.updated
descriptionstring | null
Optional human-readable label.
enabledboolean
Whether the endpoint is active.
signing_secretstring | null
Secret used to verify delivery signatures. Returned only when the webhook is created or fetched by ID.
created_atstring<date-time> | null
When the endpoint was created.
400
401
429