Skip to main content
WEBHOOK

Body

application/json

Callback payload.

​
uuid
string<uuid>
required
deprecated

Call ID. Deprecated — use id instead.

Example:

"5dccb6b0-f35c-488c-867b-86fb012c4415"

​
id
string<uuid>
required

Call ID. Alias of uuid.

Example:

"5dccb6b0-f35c-488c-867b-86fb012c4415"

​
event_type
enum<string>
required

Most recent lifecycle event for the call. One of:

  • call_setup — the call is being initiated.
  • ringing — the destination is ringing.
  • early_media — early media (such as ringback) is playing before answer.
  • answered — the destination answered the call.
  • completed — the call ended normally.
  • busy — the destination was busy.
  • cancelled — the call was cancelled before answer.
  • rejected — the destination rejected the call.
  • on_call_event — an in-call event occurred (see event_payload).
Available options:
call_setup,
ringing,
early_media,
answered,
completed,
busy,
cancelled,
rejected,
on_call_event
Example:

"call_setup"

​
event_time
string<date-time>
required

Date and time of the latest event in ISO 8601 format.

Example:

"2025-09-22T12:56:38.547Z"

​
event_payload
object | null
required

Event-specific metadata.

Example:
​
from
string
required

Caller ID.

Example:

"+18045961058"

​
to
string
required

Destination number.

Example:

"17653889567"

​
call_started
string<date-time>
required

Date and time when the call started in ISO 8601 format.

Example:

"2025-09-22T12:56:38.547Z"

​
call_answered
string<date-time> | null
required

Date and time when the call was answered in ISO 8601 format.

​
call_completed
string<date-time> | null
required

Date and time when the call ended in ISO 8601 format.

​
machine_detected
boolean
required

Indicates whether the call was answered by a machine.

Example:

false

​
tag
string
required

Call metadata

Example:

"marketing-campaign"

​
direction
enum<string>

Direction of the call. One of inbound (call received by the account) or outbound (call placed by the account).

Available options:
inbound,
outbound

Response

200

Return a 200 status to indicate that the data was successfully received