emit() is now supportedFollowing 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.
Extensions on API version 2027-01 or latercan call shopify.appEvents.emit() .shopify app dev : extensions in preview there can send events too.
App Bridge -based apps can call the same method from their app pages in the Shopify admin. No specific API version is required.
The method takes an event handleand an optionalattributes object.
shopify.appEvents.emit("description_generated", { word_count: 120, placement: "product_details", });
Shopify attaches the app and shop to each event.No access token or shop ID needed.
Do not include in attributes: names, email addresses, phone numbers, staff IDs, customer IDs , or any other personally identifiable data.
| Case | Can 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 |
Per extension,a burst of up to 20 eventsfollowed by 2 events per secondat most.
Same limits, but shared across the entire app within a single Shopify admin tab.
Admin-side events aren't used for billing. For Shopify App Pricing usage reporting,send billing events from your backend.
emit() — always check its return value.For Admin UI extensions, set shopify.extension.toml to api_version = "2027-01" or later.
Pass an event handle and any optional attributes.
shopify app dev — run it, then use the extension or app on a dev store.
success is false, check error for the cause.
Open Logs in the Dev Dashboard and confirm the events are arriving.
Shopify attaches the app and shop for you, so there's no need to pass access tokens or shop IDs to the frontend.
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.
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.
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.
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.
emit("description_generated", { word_count, placement }) send it.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 .shopify.appEvents.emit() just call it.emit() for tracking, and for Shopify App Pricing usage reporting, sendbilling events from your backend instead.shopify.appEvents.emit() in a single line.