Recording Webhooks

📘
View the webhooks dashboard

(US) us-east-1

(US) us-west-2

(EU) eu-central-1

(JP) ap-northeast-1

Recording Artifact Webhooks

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

Recording artifact status change webhook

You can receive a webhook notifying you when the recording artifact status changes (e.g., from processing to done).

{
  "event": string,
  "data": {
    "data": {
      "code": string,
      "sub_code": string | null,
      "updated_at": string // ISO86001
    },
    "recording": {
      "id": string,
      "metadata": object
    },
    "bot": {
      "id": string,
      "metadata": object
    }
  }
}

You must explicitly subscribe to each event you want to receive from the dashboard, as defined in the table below.

Recording artifact webhook events and codes

Event	Code	Description
`recording.processing`	`processing`	The recording has started
`recording.done`	`done`	The recording has successfully completed. All data for media objects on the recording is now available
`recording.failed`	`failed`	The recording failed to be captured. The `data.data.sub_code` will contain machine readable code for the failure
`recording.deleted`	`deleted`	The recording has been deleted from Recall systems.

Recording Media Artifact Status Webhooks

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

Transcript artifact status change webhook

You can receive a webhook notifying you when the transcript artifact status changes (e.g., from processing to done))

{
  "event": string,
  "data": {
    "data": {
      "code": string,
      "sub_code": string | null,
      "updated_at": string // ISO86001
    },
    "transcript": {
      "id": string,
      "metadata": object,
    },
    "recording": {
      "id": string,
      "metadata": object
    },
    "bot": {
      "id": string,
      "metadata": object
    }
  }
}

You must explicitly subscribe to each event you want to receive from the webhooks dashboard, as defined in the table below.

Transcript artifact webhook events and codes

Event	Code	Description
`transcript.processing`	`processing`	The media object has started capturing
`transcript.done`	`done`	The media object has successfully completed. All data for media objects on the recording is now available
`transcript.failed`	`failed`	The media object failed to be captured. The `data.sub_code` will contain machine readable code for the failure. See below for list of sub codes
`transcript.deleted`	`deleted`	The media object has been deleted from Recall systems.

Transcript artifact webhook sub codes

Below are a list of sub_code that can be found on a transcript.failed webhook event.

Sub Code	Reason
`provider_connection_failed`	Recall is not able to connect to the 3rd party transcription provider. Common reasons for these include: * Insufficient funds in the transcription provider account for which the API key is provided * Using paid features on a free account * Temporary service unavailability from the transcription provider
`zoom_global_captions_disabled`	Meeting captions are disabled by the Zoom account
`zoom_host_disabled_meeting_captions`	The host of Zoom meeting has disabled meeting captions
`zoom_captions_failure`	There was an error in enabling meeting captions for the Zoom call

Participant Events Artifact Webhook

You can receive a webhook notifying you when the participant_events artifact status changes (e.g., from processing to done).

{
  "event": string,
  "data": {
    "data": {
      "code": string,
      "sub_code": string | null,
      "updated_at": string // ISO86001
    },
    "participant_events": {
      "id": string,
      "metadata": object,
    },
    "recording": {
      "id": string,
      "metadata": object
    },
    "bot": {
      "id": string,
      "metadata": object
    }
  }
}

You must explicitly subscribe to each event you want to receive from the webhooks dashboard, as defined in the table below.

Participant event artifact webhook events and codes

Event	Code	Description
`participant_events.processing`	`processing`	The media object has started capturing
`participant_events.done`	`done`	The media object has successfully completed. All data for media objects on the recording is now available
`participant_events.failed`	`failed`	The media object failed to be captured. The `data.sub_code` will contain machine readable code for the failure
`participant_events.deleted`	`deleted`	The media object has been deleted from Recall systems.

Video mixed artifact webhook

You can receive a webhook notifying you when the video_mixed artifact status changes (e.g., from processing to done)

{
  "event": string,
  "data": {
    "data": {
      "code": string,
      "sub_code": string | null,
      "updated_at": string // ISO86001
    },
    "transcript": {
      "id": string,
      "metadata": object,
    },
    "recording": {
      "id": string,
      "metadata": object
    },
    "bot": {
      "id": string,
      "metadata": object
    }
  }
}

You must explicitly subscribe to each event you want to receive from the webhooks dashboard, as defined in the table below.

Video mixed artifact webhook events and codes

Event	Code	Description
`video_mixed.processing`	`processing`	The media object has started capturing
`video_mixed.done`	`done`	The media object has successfully completed. All data for media objects on the recording is now available
`video_mixed.failed`	`failed`	The media object failed to be captured. The `data.sub_code` will contain machine readable code for the failure. See below for list of sub codes
`video_mixed.deleted`	`deleted	The media object has been deleted from Recall systems

Video separate artifact webhook

You can receive a webhook notifying you when the video_separate artifact status changes (e.g., from processing to done)

{
  "event": string,
  "data": {
    "data": {
      "code": string,
      "sub_code": string | null,
      "updated_at": string // ISO86001
    },
    "transcript": {
      "id": string,
      "metadata": object,
    },
    "recording": {
      "id": string,
      "metadata": object
    },
    "bot": {
      "id": string,
      "metadata": object
    }
  }
}

You must explicitly subscribe to each event you want to receive from the webhooks dashboard, as defined in the table below.

Video separate artifact webhook events and codes

Event	Code	Description
`video_separate.processing`	`processing`	The media object has started capturing
`video_separate.done`	`done`	The media object has successfully completed. All data for media objects on the recording is now available
`video_separate.failed`	`failed`	The media object failed to be captured. The `data.sub_code` will contain machine readable code for the failure. See below for list of sub codes
`video_separate.deleted`	`deleted	The media object has been deleted from Recall systems

Audio mixed artifact webhook

You can receive a webhook notifying you when the audio_mixed artifact status changes (e.g., from processing to done)

{
  "event": string,
  "data": {
    "data": {
      "code": string,
      "sub_code": string | null,
      "updated_at": string // ISO86001
    },
    "transcript": {
      "id": string,
      "metadata": object,
    },
    "recording": {
      "id": string,
      "metadata": object
    },
    "bot": {
      "id": string,
      "metadata": object
    }
  }
}

You must explicitly subscribe to each event you want to receive from the webhooks dashboard, as defined in the table below.

Audio mixed artifact webhook events and codes

Event	Code	Description
`audio_mixed.processing`	`processing`	The media object has started capturing
`audio_mixed.done`	`done`	The media object has successfully completed. All data for media objects on the recording is now available
`audio_mixed.failed`	`failed`	The media object failed to be captured. The `data.sub_code` will contain machine readable code for the failure. See below for list of sub codes
`audio_mixed.deleted`	`deleted	The media object has been deleted from Recall systems

Audio separate artifact webhook

You can receive a webhook notifying you when the audio_separate artifact status changes (e.g., from processing to done)

{
  "event": string,
  "data": {
    "data": {
      "code": string,
      "sub_code": string | null,
      "updated_at": string // ISO86001
    },
    "transcript": {
      "id": string,
      "metadata": object,
    },
    "recording": {
      "id": string,
      "metadata": object
    },
    "bot": {
      "id": string,
      "metadata": object
    }
  }
}

You must explicitly subscribe to each event you want to receive from the webhooks dashboard, as defined in the table below.

Audio separate artifact webhook events and codes

Event	Code	Description
`audio_separate.processing`	`processing`	The media object has started capturing
`audio_separate.done`	`done`	The media object has successfully completed. All data for media objects on the recording is now available
`audio_separate.failed`	`failed`	The media object failed to be captured. The `data.sub_code` will contain machine readable code for the failure. See below for list of sub codes
`audio_separate.deleted`	`deleted	The media object has been deleted from Recall systems

Meeting metadata artifact webhook

You can receive a webhook notifying you when the meeting_metadata artifact status changes (e.g., from processing to done).

{
  "event": string,
  "data": {
    "data": {
      "code": string,
      "sub_code": string | null,
      "updated_at": string // ISO86001
    },
    "transcript": {
      "id": string,
      "metadata": object,
    },
    "recording": {
      "id": string,
      "metadata": object
    },
    "bot": {
      "id": string,
      "metadata": object
    }
  }
}

You must explicitly subscribe to each event you want to receive from the webhooks dashboard, as defined in the table below.

Meeting metadata artifact webhook events and codes

Event	Code	Description
`meeting_metadata.processing`	`processing`	The media object has started capturing
`meeting_metadata.done`	`done`	The media object has successfully completed. All data for media objects on the recording is now available
`meeting_metadata.failed`	`failed`	The media object failed to be captured. The `data.sub_code` will contain machine readable code for the failure. See below for list of sub codes
`meeting_metadata.deleted`	`deleted	The media object has been deleted from Recall systems