• Update your app
  • Ensure compatibility with the new Shopify admin domain
  • Support Shopify admin performance tracking

Updating Shopify App Bridge

Keeping your app up to date is important to ensure that users have a high-quality, performant, and secure experience. You should periodically update your app's version of Shopify App Bridge to the latest version to ensure that it continues to function and has access to all of the latest features. You might need to make additional updates to your app to support certain features.

Update your app

Anchor link to section titled "Update your app"

To update an app to the latest version of App Bridge, use the following guides. Start with the guide that indicates how to upgrade from the version of App Bridge that your app currently uses and then follow all subsequent guides.

  • Upgrading from legacy SDKs to Shopify App Bridge
  • Upgrading from App Bridge 1.x to 2.0
  • Upgrading from App Bridge 2.x to 3.0

Ensure compatibility with the new Shopify admin domain

Anchor link to section titled "Ensure compatibility with the new Shopify admin domain"

Caution

As a result of our efforts to consolidate Shopify's admin domains, we no longer support apps built with the Embedded App SDK (EASDK), the POS App SDK, or App Bridge version 1.x.

Apps built using unsupported libraries might experience degraded functionality, including longer load times. Banners and screens indicating that the app is outdated will be displayed to users.

Stores loading your app might use the old myshopify.com domain, or the new admin.shopify.com domain. To ensure that your app continues to work properly with stores that use the new domain, do the following:

  1. Ensure that the content security policy includes admin.shopify.com.
  2. Update App Bridge to version 2.0.5 or higher. We recommend updating to version 3.2.0 or higher.
  3. Initialize App-Bridge with the host parameter.

Support Shopify admin performance tracking

Anchor link to section titled "Support Shopify admin performance tracking"

Shopify uses Web Vitals to determine the performance of your app in the Shopify admin. To enable Shopify to gather Web Vitals metrics, you might need to update to the latest version of App Bridge by adding the App Bridge script to your app's head. The App Bridge script can exist alongside App Bridge installed as a packaged dependency and does not require a full migration.

Updating your app to a version that supports admin performance tracking is a prerequisite to reaching Built for Shopify status.

On this page

  • Update your app
  • Ensure compatibility with the new Shopify admin domain
  • Support Shopify admin performance tracking