API ReferenceWebhooks

Update Webhook Subscription

Update a webhook subscription

Required OAuth 2.0 scopes: application/webhooks:read, application/webhooks:write

Path parameters

subscription_idstringRequired>=1 character<=100 characters
The unique identifier of the subscription.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
enabledboolean or nullOptional

A flag to enable/disable the subscription.

event_typeslist of enums or nullOptional
A list of event types to bind the subscription to.
Allowed values:
namestring or nullOptional>=1 character<=255 characters
A friendly name to describe the subscription.
notification_urlstring or nullOptionalformat: "uri">=1 character<=2083 characters
The URL to be notified when an event occurs.

Response

Successful Response
created_atstringformat: "date-time"
The subscription creation date and time in ISO 8601 format.
enabledboolean
A flag indicating whether the subscription is enabled.
event_typeslist of enums
A list of event types the subscription is bound to.
Allowed values:
idstring
The unique identifier of the subscription.
namestring
A friendly name to describe the subscription.
notification_urlstring
The URL to be notified when an event occurs.
secretstring or null
The secret used to verify the payload of a webhook, only available upon creation.
updated_atstringformat: "date-time"
The date and time the subscription was last modified in ISO 8601 format.

Errors