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

string
Represents the version of the event. Uses semantic versioning to inform a consumer if the payload has introduced any breaking changes.
string
Represents the type of the event described in the payload.
string
An identifier representing this specific event. Treat it as opaque; its leading segment identifies the webhook configuration the event was delivered to.
object
An object representing the event, whose fields are described below.
number
Documenting when the webhook itself was sent. This timestamp is different than the time of the event the webhook describes.

Payload

integer
The Unix epoch time in seconds representing when streaming error occurred.
string
The streaming instance ID.
string
The error message returned. Any RTMP URL in it is reduced to scheme://host[:port].
string
The name of the room where streaming error occurred.
string
ID of the domain for which streaming error occurred.
object
Context for the error. endpoints has the same meaning as in the details of streaming.warning.
  • action_trace_id (string): ID of the request that triggered this event. Quote it when contacting support.
  • endpoints (string[]): the destinations the error is about: the streaming_endpoints name when the destination was given by name, otherwise the scheme://host[:port] of the RTMP URL. The full URL carries the stream key and is never sent. Present only when the error is tied to specific destinations.