Skip to main content

Update subscription

Required scopes:

  • partner.webhooks.manage
Path Parameters
subscriptionId uuid REQUIRED

ID of the subscription to update

Request Body

Subscription update request

webhookUrl string

Webhook HTTPS endpoint url.

webhookVersion string

Possible values: [v1]

Version that will be used when formatting the webhook payload.

secret string

Possible values: 10 ≤ length ≤ 50

Webhook secret that will be used for signing the request.

enabled boolean

Flag for enabling/disabling the subscription. If subscription is disabled the webhook won't be triggered for the respective event types.

eventTypes string[]

List of event types for the subscription. Each time that some event type from the list occurs, the webhook will be triggered.

Responses
200

OK

Schema OPTIONAL
id uuid

Id of the subscription in GUID format

webhookUrl string

Webhook HTTPS endpoint url.

webhookVersion string

Possible values: [v1]

Version that will be used when formatting the webhook payload.

enabled boolean

Flag for enabling/disabling the subscription. If subscription is disabled the webhook won't be triggered for the respective event types.

created date-time

Time at which subscription has been created.

eventTypes string[]

List of event types for the subscription. Each time that some event type from the list occurs, the webhook will be triggered.