Recording Error

If an error occurs during recording, or before a recording can be started, a recording.error event may be emitted. You may still receive a recording.started event, or recording.ready-to-download event, depending on when the error was emitted during the recording 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.

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

string

A string describing the event that was emitted.

string

The error message returned.

string

The recording instance ID that was passed into the start recording command.

string

The name of the room where the recording was made.

integer

The Unix epoch time in seconds representing when the error was emitted.

{
  "version": "1.0.0",
  "type": "recording.error",
  "id": "rec-err-c3df927c-f738-4471-a2b7-066fa7e95a6b-1693402871",
  "payload": {
    "action": "cloud-recording-error",
    "error_msg": "cloud-recording-error: Error fetching STS credentials",
    "instance_id": "c3df927c-f738-4471-a2b7-066fa7e95a6b",
    "room_name": "iM5wNQvwtK4980eP049T",
    "timestamp": "1693402871"
  },
  "event_ts": 1693402871.203
}

​Common fields

​Payload

Common fields

Payload