Skip to main content
A streaming error event emits when an error occurred when starting or during a live stream. You might still receive other streaming events, depending on when the error has occurred during the streaming lifecycle.

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 streaming error occurred.
instance_id
string
The streaming instance ID.
error_message
string
The error message returned.
room_name
string
The name of the room where streaming error occurred.
domain_id
string
ID of the domain for which streaming error occurred.
{
  "version": "1.0.0",
  "type": "streaming.error",
  "id": "str-err-c3df927c-f738-4471-a2b7-066fa7e95a6b-1692124183",
  "payload": {
    "timestamp": 1692124183,
    "instance_id": "c3df927c-f738-4471-a2b7-066fa7e95a6b",
    "error_message": "rtmp-error: Failed to connect: 'publish' cmd failed: connection closed remotely",
    "room_name": "iM5wNQvwtK4980eP049T",
    "domain_id": "96df0296-b344-4abb-8b78-82df35cc58f4"
  },
  "event_ts": 1692124183
}