Ask or search…


Learn about the structure of events and when they are created.
When something noteworthy happens in your account, we create a data object. More specifically, an event is created when the state of another API resource changes. Your integration can use these events to listen for and handle important updates in your account.
In the Commerce APIs, there are numerous event types that you can subscribe to when you create or edit a webhook. You can choose what you want to monitor from the list of event types.
Nearly all cases, an event's data contains the resource whose state changed.
To subscribe to an event, you must set up webhooks that send designated events directly to an endpoint on your server. You'll find a complete list of our supported event types in Global Commerce. To access this list, sign in to Global Commerce, select Administration, and click Webhook Service.

Event types

Event types use the following naming conventions: subscription.created
The name of the event usually reflects the current state of the resource. For example, when a subscription moves into the created state, we create a subscription.created event; when a subscription moves into a renewed state, we create a subscription.renewed event.

Event data

In the payload of an event, the data object typically contains the resource that changed. For example, the data object of a subscription.created event is a subscription in the created state.