Skip to main content
WEBHOOK
On-call-event
{
  "uuid": "5dccb6b0-f35c-488c-867b-86fb012c4415",
  "event_type": "call_setup",
  "event_time": "2025-09-22T12:56:38.547Z",
  "event_payload": null,
  "from": "+18045961058",
  "to": "17653889567",
  "call_started": "2025-09-22T12:56:38.547Z",
  "call_answered": null,
  "call_finished": null,
  "machine_detected": false,
  "tag": ""
}

Body

application/json
​
uuid
string<uuid>

Call ID

Example:

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

​
event_type
string

The latest call event

Example:

"call_setup"

​
event_time
string<date-time>

Date and time of the latest event

Example:

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

​
event_payload
object | null

Event-specific data

Example:

null

​
from
string

Caller ID

Example:

"+18045961058"

​
to
string

Destination number

Example:

"17653889567"

​
call_started
string<date-time>

Date and time when the call started

Example:

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

​
call_answered
string<date-time> | null

Date and time when the call was answered

Example:

null

​
call_finished
string<date-time> | null

Date and time when the call ended

Example:

null

​
machine_detected
boolean

Indicates whether the call was answered by an answering machine

Example:

false

​
tag
string

Call metadata

Example:

""

Response

200

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

⌘I