App event monitoring

You can track the changes that apps make in the stores in your organization by using App event monitoring. This monitoring allows Shopify to send real-time events to your data consumers regarding any changes made in your stores by public, private, or custom apps.

Before you start monitoring app activity

Before you start monitoring your app activity, review the following considerations:

  • App monitoring is performed through Google Cloud Platform Pub/Sub. Before you set up app monitoring in your organization, ensure that you have a Google Cloud Platform account and verify that you are comfortable working within the Google Cloud Platform.
  • Setting up a source with Google Pub/Sub in Shopify requires the App monitoring administration access.
  • Emails that indicate success when creating or deleting a source are sent to the user that sets up event monitoring and the organization owner. Emails that indicate an issue with event monitoring are sent only to the user that sets up it up.
  • Only one source can be set per organization.
  • App monitoring only tracks the changes that public, private, and custom apps make to customers and orders.

Setting up Google Cloud Platform Pub/Sub

To set up app monitoring for your organization, you need to set up a source within Shopify to send events to the Google Cloud Platform Pub/Sub.

Steps:

  1. From your Shopify organization admin, click App monitoring.
  2. Click Create source.
  3. Copy the value in the Service account email.
  4. In your Google Cloud Platform Pub/Sub topic, enter the Service account email value as a member with the Pub/Sub Publisher role.
  5. Copy the following information from the Pub/Sub and enter on the Create source page:
    • Project ID. Project IDs must be a string between 6 and 30 characters, start with a letter, and consist of lowercase letters, digits, or hyphens.
    • Topic ID. Topic IDs must be a string less than 255 characters in length and start with a letter.
  6. Click Create source.

An email is sent to the user creating the source and to the organization owner indicating that app events are being published to Google Pub/Sub.

If there are issues with event monitoring, then an email is sent only to the user creating the source. Emails will be sent in the following cases:

  • Breaking changes to the API
  • Errors when creating or deleting a source
  • Errors in app monitoring when adding or removing a store in your organization

After your source is active, you can retrieve app activity data from Google Pub/Sub and send it to your data consumers. There are many ways to integrate the information you get from Google Pub/Sub with downstream services, either by using Google's data flow pipeline or by writing your own scripts as a Cloud Function to be run by Google Cloud Pub/Sub Triggers.

Deactivating Google Cloud Platform Pub/Sub

If you need to deactivate app monitoring for your organization, or want to activate a new source for event monitoring, then you can delete your source.

Steps:

  1. From your Shopify organization admin, click App monitoring.
  2. Click the trash icon.
  3. Click Delete source.

An email is sent to the user creating the source and to the organization owner indicating that the source has been deleted. After your source is deleted, you can create a new source.

Ready to start selling with Shopify?

Try it free