Skip to main content
PATCH
Update a webhook

Authorizations

Authorization
string
header
required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Headers

Idempotency-Key
string

Reuse this key for retries of the same write. Scoped to this API key; retained for 30 days, after which the key may be reused. Different requests with the same key return 409.

Required string length: 1 - 128
Pattern: ^[!-~]+$

Path Parameters

webhook_id
integer
required

Body

application/json
url
string | null
Required string length: 1 - 1024
events
string[] | null
Required array length: 1 - 16 elements
Required string length: 1 - 32
description
string | null
Maximum string length: 255
is_active
boolean | null

true re-enables a subscription (also one WisePIM switched off) and clears its failure state.

Response

OK

id
integer
required
url
string
required
description
string
required
events
string[]
required
is_active
boolean
required
consecutive_failures
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
disabled_reason
string | null

Why WisePIM switched the subscription off: delivery_failures, backlog_full, endpoint_gone, or issuer_revoked (the person who set it up no longer has access to the project).

disabled_at
string<date-time> | null
last_success_at
string<date-time> | null
last_failure_at
string<date-time> | null
last_response_code
integer | null