Recording.Live.InProgress
The Recording.Live.InProgress webhook event is emitted whenever live recording starts, which can be triggered by setting liveRecording
option to true when a conference is created. The event is also emitted when a remix of a conference is requested using the remix API.
{
"createdAt": "2023-05-01T00:00:00.200Z",
"eventType": "Recording.Live.InProgress",
"region": "String",
"thirdPartyId": "example_thirdpartyId",
"conference": {
"confId": "conferenceId_UUID"
},
"startedAt": "2023-05-01T00:00:00.200Z",
"layoutUrl": "example_layoutUrl",
"mixId": "String[customer provided mixID]",
"height": 1080,
"width": 1920,
}
The following table explains all fields of the webhook object:
Field name | Object | Mandatory | Type | Meaning | Example |
---|---|---|---|---|---|
createdAt | Root | Mandatory | String, ISO 8601 UTC date time | The creation time for the webhook event. | 2023-05-01T00:00:00.100Z |
eventType | Root | Mandatory | String | The webhook event type. | Recording.Live.InProgress |
region | Root | Mandatory | String | The recording storage region, which matches the conference's creation region. The possible values are: ca : Canada, us : United States, eu : Europe, in : India, au : Australia | eu |
thirdPartyId | Root | Mandatory | String | The app key. If you implemented a common webhook listener for multiple applications, this can help you to distinguish which application is this webhook event for. | XSTXp4EsAmMrcw4g== |
conference. confId | Root | Mandatory | String in UUID format | The identifier of the conference. | a88484c6-2a47-4691-86e2-933eec80b316 |
startedAt | Root | Mandatory | String, ISO 8601 UTC date time | The start time of the recording. | 2023-05-01T00:00:00.100Z |
layoutUrl | Root | Optional | String | The layout URL for generating the mixed video recording. This field is included only when MP4 or BOTH recording format is set. | - |
mixId | Root | Optional | String | The optional identifier provided by you when you started mixed recording with video. This ID helps to identify which layout and configuration was used to generate the mixed recording. This field is included only when the MP4 or BOTH recording format was set. | landscape-stage |
height | Root | Optional | Number | The frame height of the mixed video recording. The default value is 1080. This field is included only when MP4 or BOTH recording format is set. | 720 |
width | Root | Optional | Number | The frame width of the mixed video recording. The default value is 1920. This field is included only when MP4 or BOTH recording format is set. | 1280 |
Updated 8 months ago