About Events

Events are triggered when specific conditions on your app or a user’s site are met. You can write code that runs when an event occurs.

For example, an event might be triggered when an eCommerce order is canceled. You can implement logic that sends an email to the site visitor when the event is triggered.

How you handle events depends on which frameworks you use to build your app:

Where to find event information

The API Reference documentation sidebar lists events alongside their related API methods.

For example, information about the Cart Created event is located under eCommerce > Purchase Flow > Cart.

Subscribe to app management events to track your app's lifecycle, particularly:

  • App Instance Installed: Triggered when your app is installed on a site. Use this to save the instance ID, provision resources, or initialize settings.
  • App Instance Removed: Triggered when your app is uninstalled. Use this to clean up data or revoke access.
Did this help?