Skip to main content
IVR webhooks notify your system about the lifecycle of each call: when the call starts, is answered, receives a digit (DTMF) and when it ends. They let you track your voice campaign in real time and react to the recipient’s interactions.

Account webhook (voice channel)

The IVR uses an account webhook, configured once per account in the Dashboard, on the voice channel. All voice events of the account — bulk campaigns and single calls — are delivered to that same endpoint.
In the Dashboard you can restrict which events the webhook receives. If no restriction is set, all voice channel events are delivered.

Envelope

Each webhook sends the event content inside data, together with channel and timestamp at the root level.
string
required
Event name: call.started, call.answered, call.dtmf or call.ended. See Events.
string
required
Source channel. Always "voice".
object
required
Call details. Fields that do not apply to the event come as null. See the Events page for each field.
string
required
Time the webhook was sent, in ISO 8601 (UTC).

Headers

X-DAPI-Signature is only sent when a secret is configured. It is the HMAC-SHA256, in hexadecimal, of the request’s raw body.

Validating the signature

Compute the HMAC over the raw body received (not over re-serialized JSON) and compare it with the header using a constant-time (timing-safe) comparison:

Delivery and reliability

Account webhooks are delivered through a durable queue, with retries, a per-URL circuit breaker and delivery logs. In case of a temporary failure, delivery is retried automatically.

How the call starts

Calls are triggered through the API; both endpoints return the callId you will see in the webhooks.
Triggers a batch of calls. Provide audioUrl (single audio) or flowId (interactive IVR flow) — exactly one of the two. Returns the batch identifier (bulkId), which is the same value delivered as callId in the webhooks.
Triggers one call to a number. It also accepts audioUrl or flowId. Returns callId — the identifier used in that call’s webhooks.
Dials and delivers the call audio in real time over WebSocket. Returns the callId used in that call’s webhooks. See Stream Calls.
For an interactive IVR (one that captures digits via DTMF), trigger the call with a flowId. Only IVR flows generate call.dtmf events.

Next steps

See the list of call lifecycle events, the fields of each one and the full table of cause codes in Events.