Integrate Web Tracking
Application Integration
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.
Event List
The following events are available in Checkout:\
Event Name | Trigger Description |
add_payment_info | User action triggered by adding/selecting payment method |
add_shipping_info | User action triggered by adding/selecting shipping information |
add_to_cart | User action triggered whenever an item is added to basket or quantity changes |
complete_checkout | User action proceeded with "Pay now" step |
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). |
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 . |
error | Error events triggered when user's behavior failed (e.g. voucher not valid, address not valid, etc.) |
express_checkout | User action proceeded by "express checkout" step feature is still under development |
feature | User action triggered by an interaction with: - billing address - gift card - newsletter - payment method preselect payment method - promotion - shipping info - voucher |
login | Trigger when a user logs in |
login_modal | User action triggered by login (email, guest) via modal |
login_with_customer_id_and_birthdate | User action triggered by login with customer id and birthdate |
loyalty_program | User action triggered by an interaction with loyalty program |
remove_from_cart | User action triggered whenever an item is removed from basket. |
set_password | Trigger when a user sets a password |
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 |
sign_up | Trigger when a user registers |
Configuration of Tracking Events
Define the configuration of tracking events.
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
Shops > [Shop] > Storefront > Checkout Settings > Checkout Frontend Configuration > Tracking
- Select overwrite level for:
- Data Layer Events
- Form Field Errors
- Send Plaintext Email