Skip to main content
WEBHOOK
streamingFailed
{
  "data": {
    "record_type": "event",
    "event_type": "streaming.failed",
    "id": "25dc3731-e51e-4927-a50d-a61cc25984b1",
    "occurred_at": "2021-12-15T14:11:24.613295Z",
    "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",
      "failure_reason": "connection_failed",
      "stream_id": "1edb94f9-7ef0-4150-b502-e0ebadfd9491",
      "stream_params": {
        "stream_url": "wss://www.example.com/websocket",
        "stream_track": "inbound_track"
      },
      "stream_type": "websocket"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
telnyx-timestamp
integer<int64>
required

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

​
telnyx-signature-ed25519
string
required

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature Ed25519 signature of timestamp|payload for verification

Body

application/json
​
data
Streaming Failed · object
Example:
{
  "record_type": "event",
  "event_type": "streaming.failed",
  "id": "25dc3731-e51e-4927-a50d-a61cc25984b1",
  "occurred_at": "2021-12-15T14:11:24.613295Z",
  "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",
    "failure_reason": "connection_failed",
    "stream_id": "1edb94f9-7ef0-4150-b502-e0ebadfd9491",
    "stream_params": {
      "stream_url": "wss://www.example.com/websocket",
      "stream_track": "inbound_track"
    },
    "stream_type": "websocket"
  }
}

Response

200

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