Subscriptions
Beta/Early Access Program This API is in the Beta/Early Access Program and is still under development. If you are interested in using this API, please contact your Customer Success Manager or Account Manager. Participation in this pilot program is at the discretion of Product Management and not guaranteed. Use of this API outside of the program is prohibited.Subscriptions allow you to define the types of events you want to be notified about and where you like notifications sent.
When a subscription has been created, it can be updated, or deleted using its subscription ID.
Each subscription contains the following properties:
subscriptionId— The unique identifier for the subscription. This ID can be used to edit or delete the subscription.name— The name of the subscription, specified during creation. The name is unique.url— The URL that the webhook events are sent to. It is a fully qualified http or https URL.events— A list of the types of events subscribed to. Each item in the list is the name of an event type. Wildcards are used to subscribe to sets of event types.enabled— Notifications are only sent to the URL if the subscription is enabled.secret— A secret used to sign notifications. The current secret is not returned in API responses except when you create a subscription.