Skip to main content
POST
Subscribe a destination to events

Authorizations

Authorization
string
header
required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Headers

Idempotency-Key
string

Up to 255 characters. The same key within 24 hours replays the first answer and creates nothing new. Build it from your own record, such as order-8842-reminder-1.

Maximum string length: 200

Body

application/json
endpoint_id
string
required
event_types
enum<string>[]
required
Required array length: 1 - 22 elements
Available options:
call.queued,
call.started,
call.completed,
call.failed,
call.aborted,
call.voicemail,
call.recording.ready,
call.analysis.completed,
call.analysis.failed,
call.analysis.skipped,
call.processed,
call.processing.completed,
campaign.started,
campaign.paused,
campaign.resumed,
campaign.completed,
campaign.stopped,
wallet.balance_low,
wallet.depleted,
wallet.balance_restored,
payment.succeeded,
payment.failed
scope
object
required
enabled
boolean

Response

201 - application/json

Subscribed

created_at
string<date-time>
required
enabled
boolean
required
endpoint_id
string
required
event_types
string[]
required
id
string
required
object
string
required
revision
integer
required
scope
object
required