call.failed: a call ended without connecting
Sent to webhook endpoints subscribed to this event (or to every event).
Sent to webhook endpoints subscribed to this event (or to every event).
webhook-id?stringThe event id (evt_…). Same on every retry and redelivery: use it to drop duplicates. Webhook endpoints only.
webhook-timestamp?stringWhen this attempt was sent, Unix seconds. Webhook endpoints only.
webhook-signature?stringSpace-separated v1,<base64 signature> values (two for 24 hours after a secret rotation). Webhook endpoints only.
X-Webhook-Id?stringSame on every retry of this delivery (the event id for webhook endpoints).
X-Webhook-Event?stringThe event type, for example call.completed.
X-Signature-SHA256?stringHex HMAC-SHA256 of the raw request body only. On webhook endpoints it is a compatibility header, keyed with the whole whsec_... string: it covers neither webhook-id nor webhook-timestamp, so a captured request can be replayed. Verify webhook-signature and reject a webhook-timestamp more than 5 minutes from your clock instead. On a campaign or agent webhook URL it is the only signature, keyed with that URL's secret (when one is set); the signed body carries timestamp, so reject one more than 5 minutes old.
application/json- body
apiVersion*stringcreatedAt*stringWhen the event happened, ISO 8601 UTC.
date-timedata*id*stringEvent id, evt_ and 32 hex characters. Same on retries and redeliveries.
type*stringReceived. Anything else is retried.
{ "apiVersion": "v1", "createdAt": "2019-08-24T14:15:22Z", "data": { "callId": "4722cd84-0ec7-4ef5-8c34-1b0150f45f53", "status": "string" }, "id": "string", "type": "call.failed"}{}call.escalated: a call was transferred to a person Webhook
Sent to webhook endpoints subscribed to this event (or to every event). A webhook URL set on a campaign or an agent receives the fields of `data` at the top level instead, plus `event` (the type) and `timestamp` (Unix seconds), signed with `X-Signature-SHA256` only.
campaign.completed: a campaign dialled every lead Webhook
Sent to webhook endpoints subscribed to this event (or to every event).