Skip to Content
CallMitraDocs
API referenceWebhooks

callback.failed: a booked callback did not reach the lead

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.

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.

Header Parameters

webhook-id?string

The event id (evt_…). Same on every retry and redelivery: use it to drop duplicates. Webhook endpoints only.

webhook-timestamp?string

When this attempt was sent, Unix seconds. Webhook endpoints only.

webhook-signature?string

Space-separated v1,<base64 signature> values (two for 24 hours after a secret rotation). Webhook endpoints only.

X-Webhook-Id?string

Same on every retry of this delivery (the event id for webhook endpoints).

X-Webhook-Event?string

The event type, for example call.completed.

X-Signature-SHA256?string

Hex 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.

Request Body

application/json
  1. body
apiVersion*string
createdAt*string

When the event happened, ISO 8601 UTC.

Formatdate-time
data*
id*string

Event id, evt_ and 32 hex characters. Same on retries and redeliveries.

type*string

Response Body

Received. Anything else is retried.

Example Requests
POST/callbackFailed
Request Body
application/json
{  "apiVersion": "v1",  "createdAt": "2019-08-24T14:15:22Z",  "data": {    "callbackId": "ad682370-8122-4447-ac96-ca5ef6191aa9",    "dialAt": "2019-08-24T14:15:22Z",    "leadId": "3c6e2b8e-0e8f-48db-8791-27271df10113"  },  "id": "string",  "type": "callback.failed"}
Header Parameters
{}