Tracking

Within Checkout, events enable the tracking of user interactions. You can find an overview of the preconfigured events below. The listed events are defined for the new GA4 structure and they work with the GTM by using the data layer instruction.

Within Checkout, by default we push events to the existing window.dataLayer array, but for embedded forms the postMessage web API is used. Normally, scripts on different pages are allowed to access each other if and only if the pages they originate from share the same protocol, port number, and host. window.postMessage() provides a secure mechanism without these restrictions.

Tracking Events

The following events are available in Checkout:

add_payment_info

User action triggered by adding/selecting payment method

{
        event: 'add_payment_info',
        ecommerce, // Google Analytics eCommerse object
        payment_type
}

add_to_cart

User action triggered whenever an item is added to basket or quantity changes

{
          event: 'add_to_cart',
          action, // Action -> `${window.location.hash}|${id}`
          price_bi, // Baskets Price
          ecommerce // Google Analytics eCommerse object
}

complete_checkout

User action proceeded with "Pay now" step

{
          event: 'complete_checkout',
          action, // `${paymentOptionKey}|${newState.orderState.id}|${newState.customer?.data.id}`,
          label
}

content_view

This event is triggered once per page when the user navigates through checkout. It could be fired several times based on the user's behavior (e.g. going forward and backwards within the same Checkout session).

{
      event: 'content_view',
      content_name, // Path
      search, // window.location.search || null,
      app_version, // i.e. 'v3'
      appId,
      page_type, // i.e. 'checkout:error_basket_empty'
}

customer_data

An event triggered every time a user logs-in, registers, sets password or initializes a Webcomponent (e.g. proceed from the basket, refreshes a page). It could be fired several times based on the user's behavior, every time submitting user related data to the dataLayer.

{
    event: 'customer_data',
    customer_id,
    unique_customer_id,
    public_key,
    reference_key,
    customer_type,
    age,
    gender,
    sessions_id_co,
    eh,
    data: {
      customerAddedNumber
    },
    logged_in
}

error

Error events triggered when user's behavior failed (e.g. voucher not valid, address not valid, etc.)

{
        event,
        action,
        label,
        value
}

express_checkout

User action proceeded by "express checkout" step

{
      event: 'express_checkout',
      action,
      label
}

feature

User action triggered by an interaction with: address book, billing address, gift card, newsletter, payment method preselect payment method, promotion, shipping info, or voucher

{
        event: 'feature',
        action, // 'submit'|'click'|'impression'|…
        label, // 'addressbook'|'add_shipping_info'|'newsletter'|'billing_adress'|…
        value, // Optional: null|'select'|'remove'|…
        name, // Optional: 'payment_method'|'voucher'|'gift_card'|'payment_method_preselect'|'newsletter'|'billing_adress'|…
        shipping_type, // Optional: 'carrier'|'collectionPoint'|…
        shipping_method, // Optional
        ecommerce // Optional: Google Analytics eCommerce object
}

Triggers, when the user logs in

{
          event: 'login',
          content_name,
          page_type,
          page_type_id,
          method,
          status,
          customer_id,
          unique_customer_id,
          eh,
          preselected_payment_method
}

login_modal

User action triggered by login (email, guest) via modal

{
      event: 'login_modal',
      action,
      label
}

login_with_customer_id_and_birthdate

User action triggered by login with customer id and birthdate

{
    event: 'login_with_customer_id_and_birthdate',
    content_name,
    page_type,
    page_type_id,
    method,
    status,
    customer_id,
    unique_customer_id,
    eh,
    preselected_payment_method
}

loyalty_program

User action triggered by an interaction with loyalty program

{
          event: 'loyalty_program',
          action, // 'add'|'remove'|'redeem'|'unredeem',
          label,
          value // Point count
}

remove_from_cart

User action triggered whenever an item is removed from basket.

{
          event: 'remove_from_cart',
          action,
          price_bi,
          ecommerce
}

set_password

Trigger when a user sets a password

{
          event: 'set_password',
          content_name,
          page_type,
          page_type_id,
          method,
          status,
          customer_id,
          unique_customer_id,
          eh
}

shop_init

This event is triggered every time a user loads a Webcomponent (e.g. proceed from the basket, refreshes a page). It could be fired several times based on the user's behavior

{
    event: 'shop_init',
    shop_id,,
    shop_version,
    shop_gender,
    locale,
    shop_currency,
    payment_method,
    shipping_method,
    landing_page,
    parameter,
    referrer,
    deeplink,
    checkout_version,
    origin,
    ecommerce
}

sign_up

Trigger when a user registers

{
      event: 'sign_up',
      content_name,
      page_type,
      page_type_id,
      method,
      status,
      customer_id,
      unique_customer_id,
      eh,
      preselected_payment_method // Optional
}

Configuration

About

Use the following configuration options to customize tracking events (under tracking):

Parameter	Description	Data Type	Possible Values
`sendPlaintextEmail`	include email address as plaintext in tracking events	`boolean`	`true` or `false`
`sendDataLayerEvents`	send datalayer events that are defined by our tracking team	`boolean`	`true` or `false`
`sendFormFieldErrors`	send datalayer events for individual form field errors	`boolean`	`true` or `false`

Before enabling sendPlaintextEmail please align with your data privacy specialists.

Example

You can find an example of these properties in JSON format below:

  "tracking": {
    "sendPlaintextEmail": false,
    "sendDataLayerEvents": true,
    "sendFormFieldErrors": false
  }

The included example configuration is also the default configuration. If you do not require different values, this does not need to be changed.

Overwrite tracking

You can overwrite tracking for a shop on the country level in the SCAYLE Panel:

Go to Settings > Checkout > Configurations > Tracking
Select overwrite level for:
- Data Layer Events
- Form Field Errors
- Send Plaintext Email