Streaming Updated

A streaming updated event emits when the call live stream was updated. These can be activated via updateLiveStreaming() or via the REST API.

Webhook Events

There are five common fields all events share:

string

Represents the version of the event. This 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.

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. For example, a recording.started event will contain a start_ts timestamp of when the actual recording started, and a slightly later event_ts timestamp indicating when the webhook event was sent.

Payload

string

The semantic version of the current message.

string

The type of event that is being provided.

Options: "streaming.updated"
number

The Unix epoch time in seconds representing when the event was generated.

object

The payload of the object, describing the given event.

integer

The Unix epoch time in seconds representing when streaming was updated.

The streaming instance ID.

string

ID of the domain for which streaming was updated.

object

The layout used for streaming.

Default Layout

string
Options: "default"

Single Participant Layout

string
Options: "single-participant"

Active Participant Layout

string
Options: "active-participant"

Portrait Layout

string
Options: "portrait"
string
Options: "vertical","inset"

Custom Layout

string
Options: "custom"