Skip to main content
PATCH
Update a webhook subscription.

Authorizations

Authorization
string
header
required

access_token returned by the /auth/v1/oauth2/tokens API call.

Path Parameters

id
string<uuid>
required

ID of the webhook subscription.

Required string length: 36
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Body

application/json

Subscription attributes.

Update a webhook subscription.

description
string

New description for the webhook subscription.

Maximum string length: 200
Example:

"My webhooks"

endpoint
string

New endpoint for the webhook subscription.

Maximum string length: 2500
Example:

"https://example.org/webhooks"

version
string

New version for the webhook subscription.

Maximum string length: 20
Pattern: ^[a-zA-Z0-9]*$
Example:

"1"

Response

Update subscriptions response.

Update webhook subscription response.

data
object