Stape GTM Server Side Magento Module

If you have your store on Magento, Stape's GTM Server Side extension for Magento 2 can simplify the process and open up the world of server-side tagging.

The list of e-commerce events:

• Collection view
• View Item
• Add to cart
• Begin checkout
• Add payment info
• Purchase

User data:

• Email
• First name
• Last name
• Customer ID

Same-origin proxy (Beta)

Serve the GTM loader and all sGTM traffic from your own store domain: requests to a
first-party path (e.g. /gtm/) are transparently forwarded by Magento to your Stape
sGTM container — no DNS, CDN or reverse-proxy setup required.

Enable it under Stores → Configuration → Stape → Stape Conversion Tracking → General →
Same-origin proxy (Beta) and set:

• Proxy path — must start with / (e.g. /gtm). Any query string or fragment is dropped, duplicate slashes are collapsed and a trailing slash is removed, so /gtm/ is stored as /gtm.

• Container API key — the full Stape container API key (not the container identifier).

After saving, use the Test connection button to verify the path is not shadowed by an
existing route, URL rewrite, redirect, or CDN/web-server rule.

Notes:

• If your nginx/Apache serves .js (or other static extensions) directly, requests under
  the proxy path with those extensions bypass PHP. The module works around this with the
  .load extension, but you can also route the proxy path to Magento explicitly, e.g. nginx:

  location ^~ /gtm/ { try_files $uri /index.php$is_args$args; }
  

• Proxy responses keep the cache lifetime your Stape container sets, but are always marked private, so browsers may reuse them while Magento's full page cache and any standards-compliant shared cache pass them through. Add an explicit rule if a cache in front of Magento is configured to ignore origin cache headers, e.g. Varnish VCL:

  sub vcl_recv {
      if (req.url ~ "^/gtm/") {
          return (pass);
      }
  }
  

  On a CDN, create an equivalent bypass rule for the same path prefix. Replace /gtm/ with the configured proxy path in both cases.

• While the same-origin proxy is fully configured, Cookie Keeper is superseded by
  first-party delivery and treated as disabled.

• The container registers its service worker from a proxied document using a relative
  URL, which the module rewrites to the .load extension so it resolves through the proxy
  like the loader does. No extra configuration is needed if you already route the proxy
  path to Magento explicitly (see the nginx snippet above).

• If CSP restrict mode is enabled (Stores → Configuration → Security → Content Security
  Policy), it is not applied to same-origin proxy responses, since proxied documents come
  from the container, not Magento, and the storefront policy could only break them.

Useful links:

• https://stape.io/blog/server-side-gtm-extension-for-magento-2
• https://stape.io/blog/facebook-conversion-api-for-magento
• https://stape.io/blog/server-side-google-analytics-4-for-magento

Changelog

v1.0.46

• fixed storefront crash when the domain list URL is empty, the cookie domain now falls back to the store host;
• fixed the cookie plugin running when the module or Cookie Keeper is disabled;

v1.0.45

• added same-origin proxy (Beta): serve the GTM loader and all sGTM traffic from the store's own domain via a configurable first-party path, with container API key parsing, custom-loader integration, admin Test connection button and save-time path conflict detection;

v1.0.44

• replaced base prices with display prices;
• fixed currency discrepancies;
• fixed item price without tax;
• added "Exclude Tax from Item price" option, item prices and line totals include tax by default;
• fixed quote item prices being pushed in base currency instead of quote currency;
• fixed add_to_cart and remove_from_cart value not accounting for quantity and not matching item price;
• added missing currency to the remove_from_cart event;
• added "Use Display Currency for Amounts" option, amounts and currency codes use the base currency by default;
• fixed catalog prices being pushed in base currency while labelled with the display currency code;
• fixed add_payment_info item prices being pushed in base currency while labelled with the quote currency code;
• grouped the transition options into a dedicated "Transition Settings" section in admin;

v1.0.43

• fixed CSP compatibility for config-stored GTM snippet by whitelisting its inline scripts via content hash (full page cache safe);
• fixed price formatting to be locale agnostic;

v1.0.42

• added EU API endpoint as backup for custom loader generation;
• fixed HTTP status code handling from webhook responses;
• fixed HYVA cart events registry issue;

v1.0.41

• added try/catch block for product collection;

v1.0.40

• fixed issue with refund webhook;

v1.0.39

• fixed exception thrown during config save with empty custom loader;

v1.0.38

• fixed HEREDOC error happening with html minify enabled in production mode;

v1.0.37

• added logic to generate GTM snippet via API;

v1.0.36

• added admin configuration option to control purchase webhook;
• added payment_type param for purchase webhook;
• added shipping_tier param for purchase webhook;

v1.0.35

• fixed PHP7.4 backward compatibility;
• fixed CSP issue on checkout;

v1.0.34

• improved SKU tracking

v1.0.33

• added cart state to datalayer events;
• extended cookies list;

v1.0.32

• datalayer event value param added;

v1.0.31

• renamed module in admin panel;
• added select_item event;
• added item_variant param to datalayer;

v1.0.30

• added module version header;

v1.0.29

• img-src CSP rule added;

v1.0.28

• added PHP 8.4 compatibility;
• fixed code style;

v1.0.27

• added option to enable/disable '_stape' suffix in Datalayer events;

v1.0.26

• removed unneeded CSP rules
• added option to configure collection size for datalayer

v1.0.24

• added caching of cookie domain when generating _sbp cookie
• Fixed issue with the overridden price formatter pattern
• Fixed billing address overwritten by shipping address issue

v1.0.23

• added logic to fetch add to cart info and send the event if only productIds array is available

v1.0.22

• fixed duplicate address creation for logged in customer on checkout

v1.0.21

• removed Stape analytics option as no longer needed

v1.0.20

• removed usage of md5 hash

v1.0.19

• Implemented custom GTM loader generation logic with prefix as well as container id

v1.0.18

• Fixed potential issue with sending multiple purchase webhook events.

v1.0.17

• Hyva theme compatibility added.

v1.0.16

• acl.xml added.

v1.0.15

• fixed logic to trim GTM- only when custom loader and custom domain are populated.

v1.0.14

• fixed xml layouts.
• changed class methods visibility from private to public.

v1.0.13

• fixed broken url generation logic.

v1.0.12

• added quote_id param to purchase event and webhook.

v1.0.11

• Update snippets with new param names and format.

v1.0.10

• Fixed item price for purchase_stape event to include tax.

v1.0.9

• Fixed issue with cookie being re-generated on every page load.

v1.0.2

• Fixed issue with main snippet not showing when cookie keeper enabled.

v1.0.1

• Set _sbp cookie logic added, unneeded functionality cleaned.

v1.0.0

• Main functionality implemented.