Recording Webhooks

Recording Status Webhook

This webhook is sent whenever the recording's status is changed and is delivered via Svix to the endpoints configured in your Recall dashboard.

{
  "event": "recording.processing", // recording.done, recording.failed, recording.deleted
  "data": {
    "data": {
      "code": string,
      "sub_code": string | null,
      "updated_at": string
    },
    "recording": {
      "id": string,
      "metadata": object
    },
    "bot": {
      "id": string,
      "metadata": object
    }
  }
}
EventDescription
recording.processingThe recording has started
recording.doneThe recording has successfully completed. All data for media objects on the recording is now available
recording.failedThe recording failed to be captured. The data.sub_code will contain machine readable code for the failure
recording.deletedThe recording has been deleted from Recall systems.

Media Object Status Webhook

This webhook is sent whenever the media object's status is changed and is delivered via Svix to the endpoints configured in your Recall dashboard. The following media object are supported

  • participant_events
  • transcript
  • video_mixed
  • video_separate
  • audio_mixed
  • audio_separate
  • meeting_metadata

Example structure:

{
  "event": "participant_events.processing",
  "data": {
    "data": {
      "code": string,
      "sub_code": string | null,
      "updated_at": string
    },
    "participant_events": {
      "id": string,
      "metadata": object,
    },
    "recording": {
      "id": string,
      "metadata": object
    },
    "bot": {
      "id": string,
      "metadata": object
    }
  }
}
EventDescription
participant_events.processingThe media object has started capturing
participant_events.doneThe media object has successfully completed. All data for media objects on the recording is now available
participant_events.failedThe media object failed to be captured. The data.sub_code will contain machine readable code for the failure
participant_events.deletedThe media object has been deleted from Recall systems.