Streaming Updated

A streaming updated event emits when an update to the call’s live stream was requested and forwarded to the media server. That is either a layout change, via updateLiveStreaming() or the REST API, or a change to the RTMP destinations, via addLiveStreamingEndpoints() / removeLiveStreamingEndpoints() or the REST add-endpoints / remove-endpoints endpoints.

Updates are applied asynchronously. This event means the request was accepted, not that it has taken effect. If the media server rejects the change or cannot apply it, a streaming.warning event follows for the same instance_id.

Common fields

string

Represents the version of the event. Uses semantic versioning to inform a consumer if the payload has introduced any breaking changes. 1.1.0 added type and endpoints.

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 the update was requested.

string

The streaming instance ID.

string

ID of the domain for which streaming was updated.

string

What the update changed: layout, add-endpoints, or remove-endpoints.

object

The layout that was requested. Present only when type is layout.

string[]

The destinations the update added or removed, as named in the request. Present only when type is add-endpoints or remove-endpoints.

A layout update:

{
  "version": "1.1.0",
  "type": "streaming.updated",
  "id": "3602-str-upd-c3df927c-f738-4471-a2b7-066fa7e95a6b-1692124183412",
  "payload": {
    "timestamp": 1692124183,
    "instance_id": "c3df927c-f738-4471-a2b7-066fa7e95a6b",
    "domain_id": "96df0296-b344-4abb-8b78-82df35cc58f4",
    "type": "layout",
    "layout": {
      "preset": "active-participant"
    }
  },
  "event_ts": 1692124183
}

An endpoints update:

{
  "version": "1.1.0",
  "type": "streaming.updated",
  "id": "3602-str-upd-c3df927c-f738-4471-a2b7-066fa7e95a6b-1692124201877",
  "payload": {
    "timestamp": 1692124201,
    "instance_id": "c3df927c-f738-4471-a2b7-066fa7e95a6b",
    "domain_id": "96df0296-b344-4abb-8b78-82df35cc58f4",
    "type": "add-endpoints",
    "endpoints": ["rtmp_youtube", "rtmp_fb"]
  },
  "event_ts": 1692124201
}

​Common fields

​Payload

Common fields

Payload