Desktop Recording SDK Webhooks

At different points in the lifecycle of a recording produced by the Desktop Recording SDK, you will receive webhook notifications about the state of the upload. Webhooks are sent through Svix and can be configured in your Recall dashboard.

📘
View the webhooks dashboard

(US) us-east-1

(Pay-as-you-go) us-west-2

(EU) eu-central-1

(JP) ap-northeast-1

Below is a comprehensive list of the recording lifecycle webhooks that are currently sent by the Desktop Recording SDK. Additional events will be added in the future, but we will not remove existing events from this list.

Event	Description
`sdk_upload.complete`	SDK Upload has finished successfully.
`sdk_upload.failed`	SDK Upload has finished unsuccessfully.
`sdk_upload.recording_started`	The Desktop SDK has started recording for this upload.
`sdk_upload.recording_ended`	The Desktop SDK has finished recording for this upload.

`sdk_upload.complete`

This webhook is sent when an SDK Upload has finished successfully.

{
  "data": {
    "data": {
      "code": "complete",
      "sub_code": null,
      "updated_at": "2025-05-10T15:48:24.034072Z"
    },
    "recording": {
      "id": "0206f11b-68ab-42b1-8a30-b85f60076e83",
      "metadata": {}
    },
    "sdk_upload": {
      "id": "fa08e580-d7b6-4f88-9f71-5b718c5a5f77",
      "metadata": {}
    }
  },
  "event": "sdk_upload.complete"
}

`sdk_upload.failed`

This webhook is sent when an SDK Upload has finished unsuccessfully.

{
  "data": {
    "data": {
      "code": "failed",
      "sub_code": null,
      "updated_at": "2025-05-10T15:48:24.034072Z"
    },
    "recording": {
      "id": "0206f11b-68ab-42b1-8a30-b85f60076e83",
      "metadata": {}
    },
    "sdk_upload": {
      "id": "fa08e580-d7b6-4f88-9f71-5b718c5a5f77",
      "metadata": {}
    }
  },
  "event": "sdk_upload.failed"
}

`sdk_upload.recording_started`

This webhook is sent when the Desktop SDK has started recording for this upload.

{
  "data": {
    "data": {
      "code": "recording_started",
      "sub_code": null,
      "updated_at": "2025-05-10T15:48:24.034072Z"
    },
    "recording": {
      "id": "0206f11b-68ab-42b1-8a30-b85f60076e83",
      "metadata": {}
    },
    "sdk_upload": {
      "id": "fa08e580-d7b6-4f88-9f71-5b718c5a5f77",
      "metadata": {}
    }
  },
  "event": "sdk_upload.recording_started"
}

`sdk_upload.recording_ended`

This webhook is sent when the Desktop SDK has finished recording for this upload.

{
  "data": {
    "data": {
      "code": "recording_ended",
      "sub_code": null,
      "updated_at": "2025-05-10T15:48:24.034072Z"
    },
    "recording": {
      "id": "0206f11b-68ab-42b1-8a30-b85f60076e83",
      "metadata": {}
    },
    "sdk_upload": {
      "id": "fa08e580-d7b6-4f88-9f71-5b718c5a5f77",
      "metadata": {}
    }
  },
  "event": "sdk_upload.recording_ended"
}