Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

Send your workspace API key as a bearer token:

Keys are scoped to a single workspace. See Authentication.

Body

application/json
url
string<uri>
required

Must be HTTPS.

events
enum<string>[]
required
Minimum array length: 1
Available options:
job.completed,
job.failed,
tracker.triggered,
entity.refreshed
description
string

Response

The created endpoint, including its signing secret.

id
string
Example:

"whk_01k3m9x7v2q8r4t6y0b1n5d7fa"

object
string
Allowed value: "webhook"
url
string<uri>
events
enum<string>[]
Available options:
job.completed,
job.failed,
tracker.triggered,
entity.refreshed
enabled
boolean
description
string | null
created_at
string<date-time>
secret
string

Returned only at creation. Used to verify the Unif-Signature header.

Example:

"whsec_7f3c1a9e4b2d8065f1a3c7e9b5d2408f"