Skip to main content
POST
Create a webhook subscription
Subscribe an HTTPS endpoint to job events. The secret field, if provided, is used to sign every delivery with HMAC-SHA256. See Verifying signatures. The secret is returned once on the create response and stripped from all subsequent list/get responses. Store it immediately. Maximum 10 webhooks per workspace. See Webhooks for the full delivery contract, event types, retry policy, and verification code.

Authorizations

x-api-key
string
header
required

Body

application/json
url
string<uri>
required
name
string
required
Required string length: 1 - 100
events
string[]
required
Minimum array length: 1
secret
string
Required string length: 16 - 256
headers
object

Response

Webhook created (secret visible once)

success
enum<boolean>
required
Available options:
true
data
object
required