Skip to main content

Get subscriptions

Required scopes:

  • partner.webhooks.manage


id uuid REQUIRED

Id of the subscription in GUID format

webhookUrl string REQUIRED

Webhook HTTPS endpoint url.

webhookVersion string REQUIRED

Possible values: [v1]

Version that will be used when formatting the webhook payload.

enabled boolean REQUIRED

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

created date-time REQUIRED

Time at which subscription has been created.

eventTypes string[] REQUIRED

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