Skip to main content
PATCH
Update webhook subscription

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string
required

Required stable id for this logical write; reuse it after a timeout. Upload endpoints also require the same value in body.idempotencyKey.

Required string length: 1 - 255

Path Parameters

subscriptionId
string
required

Subscription id from list/create responses.

Pattern: ^whs_[a-f0-9]{32}$

Body

application/json
url
string<uri>

Replacement public HTTPS callback endpoint.

Maximum string length: 2048
events
enum<string>[]

Replacement subscribed event set; deliveries outside it stop.

Required array length: 1 - 8 elements
Available options:
job.awaiting_approval,
job.progressed,
job.completed,
job.failed,
job.cancelled,
artifact.ready,
publish.completed,
publish.failed
secret
string

Replacement customer-owned HMAC secret; encrypted at rest, never returned.

Required string length: 32 - 512
status
enum<string>

Set 'disabled' to pause deliveries without deleting, 'active' to resume.

Available options:
active,
disabled

Response

Success.

success
boolean
required
subscription
object
required
{key}
any