Skip to main content
POST
Add a webhook endpoint

Authorizations

Authorization
string
header
required

An API key from the Developers page.

Body

application/json
url
string<uri>
events
enum<string>[]

Default: every event except demo.progress. "*" means all.

Available options:
demo.queued,
demo.started,
demo.progress,
demo.input_required,
demo.completed,
demo.failed,
demo.canceled,
*
description
string
Maximum string length: 200
enabled
boolean

Response

Created

id
string<uuid>
url
string<uri>
description
string
events
enum<string>[]
Available options:
demo.queued,
demo.started,
demo.progress,
demo.input_required,
demo.completed,
demo.failed,
demo.canceled,
*
enabled
boolean
disabled_at
string<date-time> | null
disabled_reason
string | null
consecutive_failures
integer
last_success_at
string<date-time> | null
last_failure_at
string<date-time> | null
created_at
string<date-time>