Skip to main content
PATCH
Update a webhook

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

webhook_id
string
required

Webhook resource ID

Body

application/json

Partial update. Only provided fields are changed.

type
enum<string> | null

New triggering event

Available options:
job_complete
Example:

"job_complete"

url
string | null

New HTTP(S) URL

Required string length: 1 - 200
Example:

"https://example.com/hooks/coval-v2"

auth_token
string | null

New secret; send null to clear the configured token.

Maximum string length: 255
Example:

"whsec_rotated_token"

Response

Webhook updated successfully

webhook
object
required

A webhook subscription. The auth token is never returned.