Skip to main content
IVR webhooks track the lifecycle of each call, from start to end. They all use the account webhook envelope: the content lives in data, with channel: "voice" and timestamp at the root level. Fields that do not apply to an event come as null.

Lifecycle events

data fields

string
required
Call identifier (the bulkId returned when triggering, or the callId returned by POST /voice/live/start for stream calls). Lets you correlate all events of the same call/batch.
string | null
required
Identifier of the individual call within the batch, or null (always null for stream calls).
string | null
required
Destination number in E.164 format, or null.
boolean | null
required
true when the call was answered. In call.answered it is always true. In call.ended it can be true, false or null. In other events, null.
number | null
required
Talk time in seconds. Present in call.ended (may be null); null in other events.
string | null
required
Key pressed in call.dtmf — a single character: "0"–"9", "*" or "#". null in other events.
number | null
required
Numeric hangup code (Q.850 + custom codes). Present in call.ended (may be null); null in other events. See the cause table.
string | null
required
Description in pt-BR matching the cause, or null. For a code without a mapped description, it returns Causa <n>.
string
required
Time of the event in ISO 8601 (UTC).

Examples by event

The other fields come as null.
answered is always true.
digits carries one key. Each key pressed generates a separate webhook.
Includes talkSeconds, cause and causeDescription.

cause table

The cause field follows the Q.850 codes plus two custom codes (150 and 151). causeDescription carries the matching description in pt-BR — the values below are returned exactly as shown.
For a cause without a mapped description in the table, causeDescription returns the generic text Causa <n>.