Skip to main content
Emitted when the dial-out session has warning.

Common fields

version
string
Represents the version of the event. Uses semantic versioning to inform a consumer if the payload has introduced any breaking changes.
type
string
Represents the type of the event described in the payload.
id
string
An identifier representing this specific event.
payload
object
An object representing the event, whose fields are described below.
event_ts
number
Documenting when the webhook itself was sent. This timestamp is different than the time of the event the webhook describes.

Payload

timestamp
integer
The Unix epoch time in seconds representing when this event occurred.
session_id
string
The sessionId of the dial-out session.
user_id
string
The userId of the dial-out session (if supplied during the API call).
domain_id
string
ID of the domain for which dial-out event occurred.
room
string
The name of the room where dial-out event occurred.
destination
string
phoneNumber (E.194 format) or the sipUri (begins with sip:) being called.
caller_id
string
callerId used for the dial-out
{
  "version": "1.0.0",
  "type": "dialout.warning",
  "id": "2868-dial-out-warn-7d208e2a-520b-4a8d-a2c9-3a36dfa0d342",
  "payload": {
    "domain_id": "04b89420-cf8b-4ea5-a428-02c40b0e2a59",
    "room": "my-dialout-room",
    "timestamp": "1728023426",
    "session_id": "7d208e2a-520b-4a8d-a2c9-3a36dfa0d342",
    "destination": "+12098888888",
    "caller_id": "34b0eb2b-4f6d-41e2-8189-c836e830ffbb"
  },
  "event_ts": 1728023426.552
}