WEBHOOK
OnCallEvent
{
  "uuid": "5dccb6b0-f35c-488c-867b-86fb012c4415",
  "event_type": "call_setup",
  "event_time": "2025-09-22T12:56:38.547Z",
  "event_payload": {
    "type": "audio",
    "payload": {
      "status": "completed",
      "playback_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  },
  "from": "+18045961058",
  "to": "17653889567",
  "call_started": "2025-09-22T12:56:38.547Z",
  "call_answered": "2023-11-07T05:31:56Z",
  "call_completed": "2023-11-07T05:31:56Z",
  "machine_detected": false,
  "tag": "marketing-campaign",
  "direction": "inbound"
}

Body

application/json

Callback payload.

​
uuid
string<uuid>
required

Call ID.

Example:

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

​
event_type
enum<string>
required

Latest call event.

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
required

Event-specific metadata.

Example:
{
  "type": "audio",
  "payload": {
    "status": "completed",
    "playback_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}
​
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>

Call direction - inbound or outbound

Available options:
inbound,
outbound

Response

200

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