Subscribe a destination to events
Webhooks
Subscribe a destination to events
Which events go to a destination, for one agent (scope.type: agent) or every agent in the workspace (scope.type: workspace). Inbound and outbound calls both count. Overlapping subscriptions to the same destination send one copy.
POST
Subscribe a destination to events
Authorizations
Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.
Headers
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:
200Body
application/json
Required array length:
1 - 22 elementsAvailable 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 - Option 1
- Option 2