Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Installation

Get information as to how to install Converge to collect customer event data across the entire user journey: from first pageload until purchase or subscription.

Table of contents

  1. Overview
  2. Tracking the storefront
    1. Storefront Event Spec
    2. Pre-built frontend integrations
    3. Headless or custom frontends
  3. Tracking the checkout
    1. Checkout Event Spec
    2. Pre-built checkout integrations
    3. Custom checkouts
  4. Tracking the Store Backend
    1. Store backend Event Spec
    2. Pre-built backend integrations
    3. Custom store backend

1. Overview

A basic Converge installation consists of installing Converge across the:

  1. Storefront
  2. Checkout
  3. Store backend

The specific installation process depends on the shopping platform you are using, whether you have a custom frontend, etc.

2. Tracking the Storefront

a) Storefront Event Spec

Converge expects the following events to be tracked across the storefront:

  • $page_load: when a user loads a page.
  • Viewed Product: when a user views a product.
  • Viewed Collection: when a user views a product collection.
  • Added To Cart: when a user adds an item to cart.
  • Subscribed To Newsletter: when a user subscribes to the newsletter.

b) Pre-built frontend integrations

Converge offers pre-made integrations for most shopping platforms that adhere to the Converge Storefront Spec You can find a full list of supported integrations with instructions per platform below:

c) Headless or custom frontends

In the case of a custom or headless frontend, you will need insert tracking statements in your frontend to make sure to track all events in the Storefront Spec using the Converge Pixel

You can find the relevant documentation + code examples here.

📌 If your headless/custom frontend and checkout live on different domains, make sure to review the section on cross-domain tracking.

📌 Make sure you pass available alias parameters for stitching your frontend session to server-side events. You can find more info about the alias parameter here

3. Tracking the Checkout

a) Checkout Event Spec

Converge expects the following events to be tracked across the storefront:

  • Started Checkout: when a user starts checking out.
  • Added Payment Info: when a user adds their payment info.

b) Pre-built integrations

Converge offers pre-made integrations for most shopping platforms checkouts that adhere to the Converge Checkout Spec You can find a full list of supported integrations with instructions per platform below:

c) Custom checkouts

In the case of a custom checkout, you will need insert tracking statements in your frontend to make sure to track all events in the Checkout Spec using the Converge Pixel

You can find the relevant documentation + code examples here.

📌 If your frontend and checkout live on different domains, make sure to review the section on cross-domain tracking.

📌 Make sure you pass available alias parameters for stitching your checkout session to server-side events. You can find more info about the alias parameter here

4. Tracking the Store Backend

a) Store Backend Event Spec

Converge expects the following events to be tracked on the store backend:

  • Placed Order: when a user places an order.
  • Started Subscription: when a user starts a subscription. (for subscription brands only)

b) Pre-built integrations

Converge offers pre-made integrations for most shopping platforms backends that adhere to the Converge Backend Spec You can find a full list of supported integrations with instructions per platform below:

c) Custom store backend

In the case of a custom backend, you will need insert tracking statements in your backend to make sure to track all events in the Backend Spec using the Converge Server-side integration

You can find the relevant documentation + code examples here.

📌 Make sure you pass available alias parameters for stitching your checkout session to server-side events. You can find more info about the alias parameter here