POST
/
user
/
webhook
/
curl --request POST \
  --url https://api.deepreel.com/user/webhook/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "endpoint": "<string>",
  "events": [
    "<string>"
  ]
}'
{
  "endpoint": "<string>",
  "key": "<string>",
  "events": [
    "<string>"
  ]
}

Authorizations

X-API-KEY
string
headerrequired

Your API key with the prefix: dr_. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the account settings panel (In the bottom left corner click on your Account → profile)

Body

application/json
endpoint
string
required

URL of the webhook endpoint to receive events

events
string[] | null
required

List of subscribable events your webhook wants to listen to. null means to subscribe to all the available events.

Response

201 - application/json
endpoint
string
required

Endpoint to listen to the subscribed events.

key
string
required

Secret key to perform HTTP Signature Verification.

events
string[]
required

Events to be observed.

Get User Subscription InfoGet registered Webhook