Webhook events serve as the method by which DeepReel informs your endpoints about various interactions or occurrences, such as the success or failure of avatar video processing. These events are transmitted by DeepReel as POST requests to your designated webhook endpoint

​
List Available Webhhok Events

See detailed API reference

Let’s begin exploring webhooks by enumerating all the available webhook events within the DeepReel API.

For now the only subscribable events are video.generation.success, and video.generation.fail

We currently support registering only one endpoint (via the dashboard).

curl -request GET
--url https://api.deepreel.com/webhook/events
--header 'accept: application/json'
--header 'x-api-key: <your-api-key>'

​
Events Payload

{
  "type": "video.generation.success",
  "error": null,
  "data": {
    "video_id": "<video_id>",
    "video_url": "<video_url>"
  }
}

​
Register a Webhook Endpoint

See detailed API reference Utilize the webhook register endpoint to register your endpoint, which will listen for DeepReel events.

events refers to the specific events you wish to process. If set to null, your endpoint will receive all supported events from DeepReel.

Please note that you can register on one webhook endpoint. Delete the old webhook before registering a new one.

curl --request POST
--url 'https://api.deepreel.com/user/webhook/' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <your-api-key>' \
--data '{
  "endpoint": "<your-endpoint>",
  "events": ["video.generation.success"]
}'

​
Get Registered Webhook Endpoint

See detailed API reference You can use this endpoint to get your registered endpoint.

curl -request GET
--url https://api.deepreel.com/user/webhook/
--header 'accept: application/json'
--header 'x-api-key: <your-api-key>'

​
Delete a Registered Webhook Endpoint

See detailed API reference

Utilize the webhook delete endpoint to delete a registered endpoint.

curl -request DELETE
--url https://api.deepreel.com/user/webhook/
--header 'x-api-key: <your-api-key>'