Skip to main content
A recording ready to download event is sent when a recording enters a finished state with a non-zero duration. At this point, a recording will exist in an S3 bucket for download. If an error ocurred during recording, you will also receive a recording.error event.

​
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

​
type
string
The type of recording that was generated.
​
recording_id
string
An ID identifying the recording that was generated.
​
room_name
string
The name of the room where the recording was made.
​
start_ts
integer
The Unix epoch time in seconds representing when the recording started.
​
status
string
The status of the given recording.
​
max_participants
integer
The number of participants on the call that were recorded.
​
duration
integer
The duration in seconds of the call.
​
s3_key
string
The location of the recording in the provided S3 bucket.
​
tracks
array
If the recording is a raw-tracks recording, a tracks field will be provided. If role permissions have been removed, the tracks field may be null.
{
  "version": "1.0.0",
  "type": "recording.ready-to-download",
  "id": "rec-rtd-c3df927c-f738-4471-a2b7-066fa7e95a6b-1692124192",
  "payload": {
    "recording_id": "08fa0b24-9220-44c5-846c-3f116cf8e738",
    "room_name": "Xcm97xRZ08b2dePKb78g",
    "start_ts": 1692124183,
    "status": "finished",
    "max_participants": 1,
    "duration": 9,
    "share_token": "ntDCL5k98Ulq",
    "s3_key": "api-test-1j8fizhzd30c/Xcm97xRZ08b2dePKb78g/1692124183028"
  },
  "event_ts": 1692124192
}