Merchants & developers

Install Apex on Shopware

Install the private Apex Shopware app package, confirm registration, and understand what Shopware data Apex receives.

The Apex Shopware app connects your Shopware store through the Shopware app manifest flow. Shopware reads the Apex manifest, registers the app with Apex, confirms the install with Shopware Admin API credentials, and then loads the Apex storefront bridge for confirmed active installations.

Use the Shopware path when you want Apex to load through the Shopware app system instead of pasting a manual script into the theme.

Before you start

  • Have Shopware Admin access with permission to install apps.
  • Get the ApexDrip private-app package from your Apex contact.
  • Make sure the Shopware server can reach the Apex app host over HTTPS.
  • Keep the app active after installation; Apex treats deactivated or deleted app installs as inactive.

Send the package to your developer

Give your Shopware developer the ApexDrip package — it is delivered to you directly by your Apex contact (request it if you have not received it; there is no public download URL). The public dynamic manifest is available for inspection only; it is not an app:install argument:

txt
https://app.drip-apex.com/api/shopware/manifest

The distributable package contains the private shared secret required for Shopware to sign registration. Do not publish or commit the package.

Install the Shopware app

  1. Extract or copy the package so the app is at custom/apps/ApexDrip in the Shopware project.
  2. Run these commands from the Shopware project root:
bash
bin/console app:refresh
bin/console app:validate ApexDrip
bin/console app:install --activate ApexDrip
  1. Approve the Apex by Drip app in Shopware Admin.
  2. Let Shopware complete registration and confirmation. This gives Apex the shop-specific credentials it needs for the app connection.
  3. Confirm the app is installed and active in Shopware Admin.

Confirm storefront tracking

After the app is confirmed, the Shopware storefront bridge resolves the current Shopware shop URL to the connected Apex shop and injects the Apex Worker snippet.

  1. Open the live storefront in a normal browser session.
  2. Visit a product page or checkout flow page.
  3. In Apex, open Installation or the Shopware analytics page and confirm the connection is active.
  4. Run a test purchase only when you are ready to verify revenue tracking.

The storefront bridge also passes Shopware order identity on checkout finish pages when the order number is visible in the page markup. That lets Apex connect server-side order events back to the visitor assignment when the storefront and webhook data line up.

What Apex receives

The manifest declares the Apex statistical cookie entry, app lifecycle webhooks, and commerce webhooks. Apex receives:

  • App lifecycle events for installed, activated, deactivated, and deleted states.
  • Order and refund events including order placed, order written, refunded, partially refunded, and cancelled signals.
  • Product update signals used to refresh product and cost context.
  • Storefront assignment and tracking events through the same Apex Worker snippet used by other storefronts.

The app requests read access for product, order, customer, sales channel, currency, and language data. Apex uses those permissions for commerce attribution, revenue analytics, and storefront context.

Troubleshooting

  • If registration fails, confirm SHOPWARE_APP_SECRET was injected into the packaged manifest and matches the Apex web runtime value.
  • If the app is installed but not connected in Apex, confirm the Shopware confirmation step completed and the app is active.
  • If no storefront events arrive, confirm the storefront can load the Apex storefront script and that consent rules are not blocking analytics before consent.
  • If revenue is missing, confirm the order webhook events return successfully and the connected shop is active in Apex.
  • If you uninstall or deactivate the app, reinstall or reactivate it before expecting new storefront or webhook data.