Transcript Error
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.
Webhook Events
There are five common fields all events share:
Represents the version of the event. This uses semantic versioning to inform a consumer if the payload has introduced any breaking changes.
Represents the type of the event described in the payload.
An identifier representing this specific event.
An object representing the event, whose fields are described below.
Documenting when the webhook itself was sent. This timestamp is different than the time of the event the webhook describes. For example, a transcript.started event will contain a start_ts timestamp of when the actual transcript started, and a slightly later event_ts timestamp indicating when the webhook event was sent.
Payload
The semantic version of the current message.
The unique identifier for this webhook event.
The Unix epoch time in seconds representing when the event was generated.
The payload of the object, describing the given event.
The unique identifier for the transcription event.
Additional information related to the transcription event.
The instance ID related to the event.
The Unix epoch time in seconds representing the start time of the transcription.
The Unix epoch time in seconds representing the end time of the transcription.
The ID of the room where the event occurred.
The meeting session ID related to the event.
The maximum number of participants allowed in the transcription session.
The duration of the session in seconds.
The cumulative participant minutes for the transcription session.
The current status of the transcription event.
The output parameters of the transcription event.
Details for the S3 storage of the transcription output.
The S3 key for the transcription output file.
The S3 bucket where the transcription output is stored.
The AWS region of the S3 bucket.
An external identifier for the S3 configuration.
The ARN of the role assumed for S3 access.
The error message associated with the transcription event.
;