Webhooks
A webhook can be specified with realtime message types recording_start, session_start, and supervisor_join_session.
Webhooks are sent as POST requests with Content-Type: application/json.
upload_ready
The webhook specified in recording_start is called if the recording was successfully uploaded.
| Parameters | Type | Description |
|---|---|---|
| status | String | Value "upload_ready". |
| msg | String | Status description. |
| rec_id | String | Affected recording. |
| client_id | String | Affected client. |
| recording_started_at | Time ISO8601 | Server-time when the recording was started. |
| recording_first_frame_written_at | Time ISO8601 | Server-time when the first video-frame was written to the recording-file. |
| recording_first_peerframe_captured_at | Time ISO8601 | Timestamp when the first video-frame was captured at the client/peer side. This information is calculated using the RTCP synchronization info provided by the webrtc-browser-implementation. |
| recording_stopped_at | Time ISO8601 | Server-time when the recording was stopped. |
| recording_file_duration_ms | Int | Duration of the recording file in [ms]. This is the duration according to the video-PTS written to the webm-file. This should exactly match the duration a webm-player might show. |
| recording_file_size_bytes | Int | Size of recording file in bytes. |
We think that for synchronization purposes the recording_first_peerframe_captured_at might be quite handy. Since it
contains a timestamp from the client it should only be compared with timestamps originated from the client as well.
upload_failed
The webhook specified in recording_start is called if the upload of the recording failed.
| Parameters | Type | Description |
|---|---|---|
| status | String | Value "upload_failed". |
| msg | String | Status description. |
| rec_id | String | Affected recording. |
| client_id | String | Affected client. |
| upload_status_code | Int | Status code when upload was tried. This reflects the http status code returned when trying to upload the recording. |
session_finished
The webhook specified in session_start is called when the session has finished.
| Parameters | Type | Description |
|---|---|---|
| status | String | Value "session_finished". |
| msg | String | Status description. |
| rec_id | String | Affected recording. |
| client_id | String | Affected client. |
| started_at | Time ISO8601 | Start of this session. |
| stopped_at | Time ISO8601 | End of this session. |
supervisor_session_finished
The webhook specified in supervisor_join_session is called when the supervisor session has finished.
| Parameters | Type | Description |
|---|---|---|
| status | String | Value "supervisor_session_finished". |
| supervisor_session_id | String | ID of the supervisor session. |
| supervisor_client_id | String | ID of the supervisor client. |
| agent_session_id | String | ID of the agent sessions. |
| agent_client_id | String | ID of the agent client. |
| started_at | Time ISO8601 | Start of this supervisor session. |
| stopped_at | Time ISO8601 | End of this supervisor session. |