Skip to main content
POST
Create webhook
Required scope: WEBHOOKS_READ_WRITE
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.

Authorizations

Authorization
string
header
required

Body

application/json
url
string<uri>
required

HTTPS URL that will receive event deliveries.

topics
enum<string>[]
required

Event topics to subscribe to (at least one).

An event topic. See the Event Catalog for payloads.

Available options:
call.received,
call.triggered,
call.answered,
call.completed,
tag.added,
tag.removed,
sms.received,
sms.sent,
contact.created,
contact.updated,
summary.updated
description
string

Optional human-readable label.

Response

Webhook created

data
object

A webhook endpoint.