Skip to main content
Version: Version 1.0

Recording

Before you start​

To receive these events, you need to have a webhook event receiver preconfigured. You also need to understand the basic structure of the events accompanying the message object. If you haven't done this yet, please refer to the Webhooks section to learn how to do it.

Events​

RECORDING​

This event is triggered when a recording status changes.

Description of message object​

The object message contains information about the recording status. It has the following properties:

PropertyTypeDescription
idstringUnique identifier for the recording.
statusstringCurrent status of the recording (e.g. 'done').

Payload example​

The following is an example of the payload sent when a recording is completed:

{
  "id": "b0a811d7-9640-42ef-8ad3-e84187547076",
  "type": "RECORDING",
  "apiKey": "ab12cd34ef56gh78ij90kl12mn34op56",
  "environment": "production",
  "timestamp": "2024-03-15T14:30:22.789Z",
  "message": {
    "id": "b0a811d7-9640-42ef-8ad3-e84187547076",
    "status": "done"
  }
}