Skip to main content
WEBHOOK
streamingStarted
{
  "data": {
    "record_type": "event",
    "event_type": "streaming.started",
    "id": "7d743d69-f7e8-4761-b7d4-8cacf9d3c031",
    "occurred_at": "2021-12-15T14:06:32.059436Z",
    "payload": {
      "call_control_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69",
      "connection_id": "7267xxxxxxxxxxxxxx",
      "call_leg_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69",
      "call_session_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69",
      "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
      "stream_url": "wss://www.example.com/websocket"
    }
  }
}

Headers

telnyx-timestamp
integer
required

Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp

telnyx-signature-ed25519
string
required

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature

Body

application/json
data
object
Example:
{
"record_type": "event",
"event_type": "streaming.started",
"id": "7d743d69-f7e8-4761-b7d4-8cacf9d3c031",
"occurred_at": "2021-12-15T14:06:32.059436Z",
"payload": {
"call_control_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69",
"connection_id": "7267xxxxxxxxxxxxxx",
"call_leg_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69",
"call_session_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69",
"client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
"stream_url": "wss://www.example.com/websocket"
}
}

Response

200

The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.