Events

Account event (sign in & sign up)

Triggers when a user logs in or signs up.

Data object


      {
        email: logged customer email,
        firstName: logged customer first name,
        lastName: customer last name,
        id: logged customer Id,
        eventAction: ['login' | 'createAccount']
      }

Add to Cart

Triggers add to cart event with a payload.

Data object


        {
          products: [
            {
              name: product name (product title + variant title),
              variant: variant title,
              id: variant sku,
              productId: product id,
              variantId: variant id,
              category: product category,
              brand: site title,
              price: variant price,
              quantity: quantity added,
              compareAtPrice: compare at price if available,
              image: variant image,
            }
          ],
          list: [collection / pdp],
          currencyCode: selected currency,
          value: total in the cart,
          location: current url location,
          customerId: logged customer id in case it's logged in,
          customerEmail: logged customer email,
          customerFirstName: logged customer first name,
          customerLastName: logged customer last name
        }

Cart View

Triggers cart view event with a payload, every time the cart opens with line items.

Data object


      {
        products: [
          name: product name,
          variant: variant title,
          id: variant sku,
          productId: product id,
          variantId: variant id,
          category: when available
          brand: site title,
          price: variant price,
          quantity: quantity of each product
        ],
        totalPrice: total price,
        currencyCode: selected currency,
        customerId: logged customer id in case it's logged in,
        customerEmail: logged customer email,
        customerFirstName: logged customer first name,
        customerLastName: logged customer last name
        
      }

Email subscribe

Triggers when a user subscribes to newsletter.

Data object


      {
        email: user email,
        formLocation: footer
      }

Initialize Checkout

Triggers when checkout it's initialized.

Data object

 
Page View
Triggers page view. It fires before all events.
Data object

      {
        page: page,
        visitorType: ['Logged In' | 'Guest'],
        visitorId: logged customer Id,
        customerEmail: logged customer email,
        customerFirstName: logged customer first name,
        customerLastName: customer last name,
        currency: selected currency,
        cartTotal: cart total price,
        lineItems: [
          {
            id: variant sku,
            name: product title + variant title,
            brand: site title,
            variant: variant title,
            price: variant price,
            quantity: quantity,
            position: index,
            productId: product id,
            variantId: variant id,
            image: variant image
          }
        ]
      }
    
 
Product Click
Search page product impressions.
Data object

      {
        name: product title + variant title,
        id: product default variant sku,
        productId: product id,
        variantId: default variant id,
        shopifyId: product id,
        price: default variant price,
        brand: site title,
        variant: default variant title,
        category: product category,
        position: position in the list,
        currencyCode: selected currency,
        list: [search term | 'empty search results'],
        location: loction url,
        customerEmail: logged customer email,
        customerFirstName: logged customer first name,
        customerLastName: customer last name,
        customerId: logged customer Id
      }
    
 
Product Detail View
Product detail view.
Data object

      {
        name: name: product title  + variant title,
        id: variant sku,
        productId: product id,
        variantId: variant id,
        shopifyId: product id, 
        price: variant price,
        brand: site title,
        variant: variant title,
        category: product category,
        compareAtPrice: compare at price,
        variantPrice: variant price,
        variantInventoryQuantity: variant inventory quantity,
        currencyCode: selectedCurrency,
        value: cart total value,
        image: variant image,
        customerEmail: logged customer email,
        customerFirstName: logged customer first name,
        customerLastName: customer last name,
        customerId: logged customer Id,
        location: current location url
      }
    
 
Remove from Cart
Triggers remove from cart event with a payload.
Data object

      {
        products: {
          currencyCode: selected currency,
          name: product name,
          variant: variant title,
          id: variant sku,
          productId: product id,
          variantId: variant id,
          brand: site title,
          price: variant price,
          quantity: quantity of each product,
          image: variant image
        },
        customerId: logged customer id in case it's logged in,
        customerEmail: logged customer email,
        customerFirstName: logged customer first name,
        customerLastName: logged customer last name
      }
    
 
Search page product impressions.
Data object

      {
        products:[
          {
            name: product title,
            id: product id,
            price: product price,
            brand: site title ,
            category: product category,
            variant: variants title,
            variantId: variants id,
            compareAtPrice: compare at price,
            list: ['Search Results' | 'empty search results'],
            position: position in the list of search results,
            productId: product id
          }
        ],
        search,
        action: [search term | 'open site search'],
        label: number of search results,
        currencyCode: selected currency,
        customerEmail: logged customer email,
        customerFirstName: logged customer first name,
        customerLastName: customer last name,
        customerId: logged customer Id
      }
    
 
Account sign up (legacy)
Triggers when a user creates an account.
Data object

      {
        email: user email
      }