Skip to main content
POST
/
v1
/
webhooks
Register webhook
curl --request POST \
  --url https://api.ringbee.dev/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "https://example.com/webhook",
  "events": [
    "job.completed",
    "job.failed"
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.ringbee.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
url
string
required
Example:

"https://example.com/webhook"

​
events
string[]
Example:
["job.completed", "job.failed"]

Response

201

Webhook registered