Skip to main content
cURL

Authorizations

Authorization
string
header
required

Issued in Developers. Workspace/owner/scopes come from credential, never acting-user headers. API keys cannot manage API credentials.

Headers

Idempotency-Key
string
required

Persist one key for this logical operation before sending it. Reuse the same value only with the same method, path and body after a timeout. A changed request returns 409 idempotency_conflict; a matching retry returns the original response.

Pattern: ^[A-Za-z0-9._:-]{1,200}$

Path Parameters

id
string<uuid>
required

Subscription UUID that you generate and persist before registration. Reuse this ID to manage the same receiver.

Body

application/json
name
string
required

A label that helps you identify the integration.

Required string length: 1 - 100
url
string<uri>
required

HTTPS receiver on port 443, without URL credentials or fragments. On verification and delivery, it must resolve exclusively to public IP addresses; redirects are not followed. Saving an inactive configuration does not establish reachability.

Maximum string length: 2000
events
enum<string>[]
required

Event types to deliver. The key must also have the read permission for every selected resource type.

Required array length: 1 - 16 elements
Available options:
contact.created,
contact.updated,
contact.deleted,
list.created,
list.updated,
list.deleted,
list.membership_updated,
call.created,
call.updated,
call.deleted,
call.completed,
call.disposition_updated,
recording.available,
transcript.available,
contact.access_revoked,
list.access_revoked

Response

Existing subscription configuration was replaced and paused, or that response was replayed.

id
string<uuid>
required

Subscription UUID chosen by the client when creating it.

name
string
required

Integration label.

url
string
required

HTTPS receiver URL.

events
enum<string>[]
required

Subscribed event types.

Available options:
contact.created,
contact.updated,
contact.deleted,
list.created,
list.updated,
list.deleted,
list.membership_updated,
call.created,
call.updated,
call.deleted,
call.completed,
call.disposition_updated,
recording.available,
transcript.available,
contact.access_revoked,
list.access_revoked
active
boolean
required

Whether delivery is enabled. Creating or replacing configuration pauses delivery until verification.

verifiedAt
string<date-time> | null
required

Time of the most recent successful verification, or null.

createdAt
string<date-time>
required

Subscription creation time in UTC.