Skip to main content
POST
register a webhook endpoint

Authorizations

Authorization
string
header
required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Body

application/json
url
string
required

https, up to 2048 characters.

description
string

Up to 500 characters.

event_types
enum<string>[]

Omitted or empty subscribes to all.

Available options:
job.succeeded,
job.failed,
job.cancelled
workspace_id
string

Response

OK

id
string
url
string
description
string
event_types
string[]

Empty means every event.

enabled
boolean
consecutive_failures
number
disabled_reason
string
last_success_at
string
last_failure_at
string
created_at
string