The Shopify Website Integration consists of two integrations covering the full tracking spec.
  1. The Shopify Storefront Integration
  2. The Shopify Checkout Integration

​
Installation Instructions

The installation process of Converge is slightly different based on whether you have a Shopify Liquid storefront; or whether you are running a Shopify Headless Storefront.
The Converge Website installation for a Shopify Liquid store consists of:
1

Create a new Client Source in Converge

  1. In Converge, go to Event sources
  2. Click on Create a new source
  3. Pick Client-side from the modal
  4. Name your pixel: e.g. {Storename} Storefront
2

Install the Converge Liquid snippet in your storefront

  1. Click on your newly created Source and pick Shopify Liquid, and copy that snippet.
  2. In the Shopify admin dashboard, navigate to Sales Channels > Online Store > Themes
  3. Click on ”…” next to the Customize button, and click Edit code.
  4. Go to the theme.liquid file and insert the snippet right above the closing </head> tag in the theme.liquid file. Click Save
3

Verify that the integration is working correctly

  1. Always double-check that you did not break anything on the site after inserting the snippet.
    It’s good practice to add the snippet to other themes in development as well and to add this snippet to your version control, so a theme switch does not kill website tracking
  2. Check that your pixel is working correctly by generating some $page_load, Viewed Product and Viewed Collection events by visiting the store and seeing that these events arrive in the Source Log.
4

Create a new Client Source in Converge

  1. In Converge, go to Event sources
  2. Click on Create a new source
  3. Pick Client-side from the modal
  4. Name your pixel: e.g. {Storename} Checkout
5

Install the Converge Checkout as an extension in Shopify Customer Events

  1. Click on your newly created Source and pick Shopify Custom Pixel, and copy that snippet.
  2. In the Shopify Admin dashboard, navigate to Settings > Customer Events
  3. Click on Add custom pixel.
  4. Name your pixel, e.g. Converge Pixel
  5. Paste the script from the web app here.
  6. Click on Save Pixel
    save pixel
  7. Under Customer Privacy, set the Permission flag to Not required.
    img
  8. Also make sure that Data sale is set to Data collected does not qualify as a data sale.
    img
  9. Click on Connect Pixel
    save pixel 1
Shopify might throw a warning that the pixel is not subscribed to any events. You can safely ignore this warning.
6

Verify that the integration is working correctly

  1. Check that your pixel is working correctly by generating some Added To Cart, Started Checkout and Added Payment Info events by visiting the store and seeing that these events arrive in the Source Log.
If you have multiple Shopify stores active in different countries, please check our guide on Shopify Internationalization here.
The integration relies on Shopify Standard Events (see Shopify Standard Events
 for reference).If you are using custom code to handle, for example, cart, checkout, or payment, it’s possible that the standard Shopify events will not be triggered or will have missing data. In those cases, you may need to implement the affected tracking events manually. See Manually instrumenting events for reference.

​
FAQ

​
Event Spec

This integration auto-tracks the following events on the browser with all properties available according to the Converge Event Spec.
Event NameEvent DescriptionIntegration
PageViewWhen a customer views a page.Storefront
Viewed ProductWhen a customer views a product.Storefront
Viewed CollectionWhen a customer views a collection of products.Storefront
Added To CartWhen a customer adds an item to cartCheckout
Started CheckoutWhen a customer initiates the checkout process.Checkout
Added Payment InfoWhen a customer adds their payment info on the checkout.Checkout
Subscribed To NewsletterWhen a customer subscribes to your newsletter.Checkout
Placed OrderWhen a customer places an order.Checkout
This integration also auto-tracks some additional events that are not part of the Converge Event Spec.
Event NameEvent DescriptionIntegration
Added Contact InfoWhen a customer fills in the contact information in the checkoutCheckout
Added Shipping InfoWhen a customer fills in their shipping info in the checkoutCheckout

​
Utility Object

Note that this utility object is not available on the Shopify Checkout.
Converge exposes a utility object called __cvg_shopify_info that picks up useful event properties and profile properties automatically. We give an example below of requesting this object and what it looks like in the code example below.