Skip to main content
PATCH
Update 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.

Path Parameters

webhook_id
string
required

Body

application/json
url
string<uri>
events
enum<string>[]
Available options:
job.completed,
job.failed,
tracker.triggered,
entity.refreshed
enabled
boolean
description
string

Response

The updated endpoint.

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>