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

id
string
The unique identifier for the transcription event.
info
object
Additional information related to the transcription event.
room_id
string
The ID of the room where the event occurred.
room_name
string
The name of the room where the event occurred.
mtg_session_id
string
The meeting session ID related to the event.
max_participants
integer
The maximum number of participants allowed in the transcription session.
duration
number
The duration of the session in seconds.
participant_minutes
number
The cumulative participant minutes for the transcription session.
status
string
The current status of the transcription event.
out_params
object
The output parameters of the transcription event.
error
string
The error message associated with the transcription event.
{
  "version": "1.1.0",
  "type": "transcript.error",
  "id": "3431-tra-err-8d5c03f3-cff3-43c7-b112-0f78989f659f",
  "payload": {
    "id": "8d5c03f3-cff3-43c7-b112-0f78989f659f",
    "info": {
      "instanceId": "a1f2f6b7-b1ac-4202-85e5-d446cb6c3d3f",
      "startTs": 1733234933,
      "endTs": 1733234946
    },
    "room_id": "9e3c9e1b-bfbe-4753-b908-fd89cecfd4a7",
    "room_name": "my-room",
    "mtg_session_id": "927be4b9-7f3c-49c4-b53d-5a003e1edf2c",
    "max_participants": 1,
    "duration": 12.955,
    "participant_minutes": 0.1885,
    "status": "t_error",
    "out_params": {
      "s3": {
        "key": "domain/room/1733234933414.vtt",
        "bucket": "domain/example",
        "region": "us-west-2",
        "externalId": "domain",
        "assumeRoleArn": "arn:aws:iam::606325061522:role/BipolCustomRoleForS3"
      }
    },
    "error": "User: arn:aws:sts::---:assumed-role/---/webvtt-upload is not authorized to perform: s3:PutObject on resource: \"arn:aws:s3:::bucet-path/1733234933414.vtt\" because no identity-based policy allows the s3:PutObject action"
  },
  "event_ts": 1733234946.616
}