Skip to main content

Support & Resources

Recording Box webhooks

Premium Features

Loading...

Recording Box webhooks

Recording Box webhooks

Get notified as soon as a new call recording is ready, so you can pull it into your CRM, compliance archive or quality review tool.

Where to set it up

  1. Go to Premium Features > Recording Box and open the box you want to edit.
  2. Open the Alerts & Webhooks tab.
  3. In the HTTP Webhooks card, turn the switch on.
  4. Enter your address in Webhook URL. It must start with https://.
  5. Optional: enter a Webhook secret (up to 64 characters).
  6. In the Alert Conditions panel, make sure Alert on recording is turned on. Webhooks are only sent when this is on.
  7. Click Save Alerts & Webhooks.

Events you will receive

EventWhen it is sent
recording_box.recording_readyA call recording has been saved and is ready.

Example message

{
  "event": "recording_box.recording_ready",
  "occurred_at": "2026-06-11T02:15:00Z",
  "account_code": "295327",
  "recording_box": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Front Desk Recording",
    "route_token": "rbx_a1b2c3d4e5f6"
  },
  "call": {
    "uuid": "550e8400-e29b-41d4-a716-446655440002",
    "status": "completed",
    "started_at": "2026-06-11T02:13:00Z",
    "caller_id": "61412345678",
    "forward_connected": true,
    "greeting_played": true,
    "recording_duration_sec": 95,
    "recording_file_size_bytes": 1520640,
    "recording_uploaded_at": "2026-06-11T02:15:00Z"
  }
}
FieldWhat it means
recording_box.uuid / nameWhich Recording Box captured the call.
call.uuidA unique ID for the call.
call.forward_connectedWhether the call was successfully forwarded to your team.
call.greeting_playedWhether your greeting played to the caller.
call.recording_duration_secLength of the recording in seconds.
call.recording_file_size_bytesSize of the recording file.
call.recording_uploaded_atWhen the recording was saved (UTC).

The webhook tells you a recording is ready. It does not include the audio itself. To collect the audio automatically, use the Recording Box SFTP or S3 export options on the same edit page, or download recordings from the portal.

To avoid processing a message twice, use the combination of call.uuid, event and occurred_at.

Cost

Email alerts, webhooks, SFTP/S3 export and greeting storage are free.

Need Help?