Skip to Content
CallMitraDocs
API referenceWebhooks

webhook.test: sent by the send test event operation

Sent to webhook endpoints subscribed to this event (or to every event).

Sent to webhook endpoints subscribed to this event (or to every event).

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/webhookTest
Request Body
application/json
{  "apiVersion": "v1",  "createdAt": "2019-08-24T14:15:22Z",  "data": {    "endpointId": "c8d2c7e1-e4b1-4108-9e29-3429a36a1ef3"  },  "id": "string",  "type": "webhook.test"}
Header Parameters
{}