Developer Changelog / App Events

App Events now supported in the Shopify admin
From Admin UI extensions and embedded apps, emit() is now supported

Following Checkout and Customer Account, the Shopify admin now supports shopify.appEvents.emit() as well. You can track app usage across all three surfaces. It's a new optional API, so no action is required.

On this page
  1. What's changing (30-second overview)
  2. How it works: how events get delivered
  3. How to call it, and data you must not send
  4. What's covered and what isn't
  5. Rate limits and billing
  6. Setup (5 steps)
  7. 5 key points for developers
  8. 3 business use cases
  9. One-line summary for proposals

1What's changing

As of Editions, App Events were available only in Checkout and Customer Account UI extensions .
This release expands it to Shopify admin(Admin UI extensions and embedded apps), so you can nowtrack app usage across all three surfaces.

Admin UI extensions

Extensions on API version 2027-01 or latercan call shopify.appEvents.emit() .shopify app dev : extensions in preview there can send events too.

Embedded apps (App Home)

App Bridge -based apps can call the same method from their app pages in the Shopify admin. No specific API version is required.

It's a new optional API, so no action is required.Existing apps and extensions keep working without changes.

2How it works: how events get delivered

Admin UI extension API 2027-01 or later Embedded apps Via App Bridge emit(handle, attrs) Shopify App and shop attached automatically No token or shop ID needed Accepted Dev Dashboard : Logs Events from the admin Events from the admin Events from the backend Shown together App backend Also sent Events (billing is handled here)
Eventsdon't include any information identifying the source extension or the staff member who performed the action. In the Dev Dashboard, they appear alongside events sent from your app's backend.

3How to call it, and what data you must not send

The method takes an event handleand an optionalattributes object.

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

App and shop

Shopify attaches the app and shop to each event.No access token or shop ID needed.

Do not send

Personally identifiable data

Do not include in attributes: names, email addresses, phone numbers, staff IDs, customer IDs , or any other personally identifiable data.

4What's supported and what isn't

CaseCan you use emit()?Notes
Admin UI extension (API 2027-01 and later) Yes shopify app dev also works while previewing
Embedded app (using App Bridge) Yes No specific API version required
Admin UI extension (before 2027-01) Not available shopify.appEvents does not exist at all
should-render targets / data targets Sends nothing {success: false, error: 'Emit is unavailable.'} is the resolved value
Embedded apps in the admin where App Events isn't available Sends nothing Returns the same result as above

5Rate limits and billing

Admin UI extension

Per extension,a burst of up to 20 eventsfollowed by 2 events per secondat most.

1 tab

Embedded apps

Same limits, but shared across the entire app within a single Shopify admin tab.

$

Not used for billing

Admin-side events aren't used for billing. For Shopify App Pricing usage reporting,send billing events from your backend.

The article doesn't specify what happens when the limit is exceeded (error details, whether to retry, etc.).emit() — always check its return value.

6Setup (5 steps)

1

Specify the API version

For Admin UI extensions, set shopify.extension.toml to api_version = "2027-01" or later.

2

Call emit()

Pass an event handle and any optional attributes.

3

Run it on a dev store

shopify app dev — run it, then use the extension or app on a dev store.

4

Check the return value

success is false, check error for the cause.

5

Confirm arrival in Logs

Open Logs in the Dev Dashboard and confirm the events are arriving.

75 key points for engineers

1. No credentials required

Shopify attaches the app and shop for you, so there's no need to pass access tokens or shop IDs to the frontend.

2027-01

2. Extensions need a minimum API version; embedded apps need App Bridge

Admin UI extensions on versions earlier than 2027-01 don't have shopify.appEvents . Embedded apps work on any API version as long as App Bridge is available.

false

3. Failures come back as return values, not exceptions

In admin contexts without should-render/data targets or App Events, the call {success:false, error:'Emit is unavailable.'} resolves with this value. Build your implementation around checking the return value.

4. No personally identifying attributes, and the sender isn't recorded

Names, emails, phone numbers, staff IDs, and customer IDs are prohibited. Events also don't record which extension or staff member sent them. If you want to break data down by extension, the article doesn't describe any way to do so other than distinguishing them with attributes.

Analytics Billing

5. Keep analytics and billing on separate paths, and account for rate limits

Events from the admin aren't processed for billing, so for Shopify App Pricing usage reporting,send a billing event from your backend. Rate limits are a burst of 20 plus 2 per second per extension, while embedded apps share a single app-wide allowance per admin tab.Avoid sending on every keystroke or scroll, and send one event per meaningful actionto stay on the safe side.

8Three practical use cases

Usage by feature
USE CASE 1

Visualize how app features are used inside the admin

Challenge
You can't tell how much the features of an Admin UI extension placed on screens like product details are actually used.
Approach
As in the article's example, when an action such as generation completes, emit("description_generated", { word_count, placement }) send it.
Impact
You can see usage across three surfaces (admin, Checkout, and Customer Account) alongside your backend events in the Dev Dashboard Logs.
Tech notes
On the extension side, api_version = "2027-01" or later is required. Because the sending extension isn't recorded, capture where the event came from in an attribute such as placement .
Before token + shop ID emit ()
USE CASE 2

Track embedded app usage without any authentication setup

Challenge
To track interactions in App Home, you have to build your own endpoint for sending data from the frontend to your backend, plus a way to identify the shop.
Approach
From pages of an embedded app that uses App Bridge, shopify.appEvents.emit() just call it.
Impact
No access token or shop ID needed. Per-shop events flow into the Dev Dashboard without building a new tracking endpoint.
Tech note
Embedded apps don't need to specify an API version. The rate limit is a single quota shared by the whole app within one admin tab (a burst of 20, then 2 per second), so keep the number of places that send events small.
admin Usage logs backend billing event
USE CASE 3

Separate tracking from billing reports in usage-based apps

Challenge
In apps that charge by usage, on-screen activity logs get mixed up with the usage that's billed, so it's unclear what should be sent from where.
Approach
Split the two: send admin UI interactions via emit() for tracking, and for Shopify App Pricing usage reporting, sendbilling events from your backend instead.
Impact
This matches the rule that admin-side events aren't billed, and prevents double billing and missed reports at the design stage.
Tech note
Both kinds of events appear in Logs in the Dev Dashboard, so choose handle names that show which path each event came from.

9One-line summary for proposals

"Extensions and embedded apps in the Shopify admin can now send usage eventsshopify.appEvents.emit() in a single line.
No token required and adoption is optional. Together with Checkout and Customer Account, usage can be tracked across 3 surfaces.
Billing reports still come from your backend, as before."