Skip to main content
POST
Create a webhook subscription

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Headers

Idempotency-Key
string

Optional client-supplied idempotency key. When present, the gateway caches the response for 24 hours and returns the same response on retried requests with the same key (account-scoped). Safe for retries on network blips. Format: 8-255 ASCII characters from [A-Za-z0-9_-].

Required string length: 8 - 255
Pattern: ^[A-Za-z0-9_-]+$
Example:

"a1b2c3d4-e5f6-7890-abcd-ef0123456789"

Body

application/json
event
string
required
Pattern: ^call\.completed(?:\.[a-z0-9_]+)?$|^lead\.status_changed$|^campaign\.(?:activated|paused)$
Example:

"call.completed.booked_callback"

url
string<uri>
required
Example:

"https://hooks.your-app.com/topcalls"

filters
object

Optional equality / array-OR / SQL-LIKE filters applied to the call-completed payload before fan-out. Top-level keys are payload field names. The special key is_conversion is matched against the derived boolean (true if the call's disposition is in the campaign's conversion_outcomes list).

Example:

Response

Webhook subscription created

id
string<uuid>
account_id
string<uuid>
event
string
Example:

"call.completed.booked_callback"

url
string<uri>
filters
object
deleted_at
string<date-time> | null
created_by_api_key_id
string<uuid> | null
created_at
string<date-time>