Skip to main content

App Events: Send events from Admin UI extensions and embedded apps

Admin UI extensions and embedded apps can now send app events to Shopify with shopify.appEvents.emit(). At Editions, we launched app events for Checkout and Customer Account UI extensions. This release adds the Shopify admin, so you can now track app usage across all three surfaces. This is a new, optional API, so no action is required.

What changed

shopify.appEvents.emit() is now available on two more surfaces:

  • Admin UI extensions: Extensions that use API version 2027-01 or later can call shopify.appEvents.emit(). Extensions that you preview with shopify app dev can also send events.
  • Embedded apps (App Home): Apps that use App Bridge can call the same method from the app's pages in the Shopify admin.

The method takes an event handle and an optional object of attributes:

shopify.appEvents.emit("description_generated", {
word_count: 120,
placement: "product_details",
});

Shopify adds your app and the shop to each event, so you do not need an access token or a shop ID. Do not include data in attributes that could identify an individual, such as names, email addresses, phone numbers, staff member IDs, or customer IDs.

Events that Shopify accepts are visible in the Dev Dashboard logs, together with the events that your app backend sends. Events do not identify the extension that sent them or the staff member who used it.

Each Admin UI extension can send a burst of up to 20 events, then 2 events per second. An embedded app has the same limit, shared across the app in one Shopify admin tab. Events from Admin UI extensions and embedded apps are not processed for billing. To report usage for Shopify App Pricing, send a billing event from your app backend.

Who's affected

This change applies to apps that have Admin UI extensions on API version 2027-01 or later, and to embedded apps that use App Bridge. Embedded apps do not need a specific API version. Admin UI extensions on earlier API versions do not have shopify.appEvents.

On should-render targets and data targets, emit() sends nothing and resolves {success: false, error: 'Emit is unavailable.'}. An embedded app gets the same result where the Shopify admin does not offer App Events.

What to do

No action is required as existing apps and extensions will continue to work without changes. If you want to send events from the Shopify admin, do these steps:

  1. For an Admin UI extension, set api_version = "2027-01" or later in shopify.extension.toml.
  2. Call shopify.appEvents.emit() with an event handle and optional attributes.
  3. Run shopify app dev and use the extension or app in a development store.
  4. Check the result of emit(). If success is false, read error for the cause.
  5. Open Logs in the Dev Dashboard to confirm that your events arrive.

Related docs

Was this page helpful?