Tealium Events Extension
The Tealium Events extension defines standard conditions for the most commonly tracked events.
This extension adds the
tealium_event variable to your data layer, where it can help simplify tag mappings, load rules, or other conditions. It can also be passed to Tealium EvenStream via the Tealium Collect tag.
- utag v4.38 or higher
How it works
This extension introduces standardized event names into your solution, along with a new variable in your data layer called
tealium_event. It covers the standard e-commerce customer journey and includes familiar events such as Add to Cart, Product Detail Page View, and Purchase Complete. Since these events are typically represented in the data layer using
event_name, this extension acts as a translation between your current page/event tracking conditions and the new standardized Tealium event names.
Each event may be assigned to a custom condition that matches your data layer implementation. When an event condition evaluates to true,
tealium_event is set to the pre-defined event value. For example, when the condition for Add to Cart evaluates to
tealium_event is set to
cart_add. See the Standard Events section below.
Using the extension
Before you begin, familiarize yourself with how extensions work.
Once the extension is added, you may customize event conditions according to your implementation needs. The list of events are not changeable, but the event conditions are changeable. To customize an event condition:
- Click an event, and then click Edit.
- Adjust the condition logic as needed.
- Click Apply.
To prevent an event from being set, remove the condition and click Apply. This changes the event from being
Not Set and is no longer be evaluated in your configuration.
In this example, the condition for the Email Signup event has been removed, resulting in the event to be
Below is a table of standard events and default conditions in the extension. Events are listed in alphabetical order and are evaluated sequentially. The default conditions match our standard data layer recommendations, but they are customizable to match your exact implementation.
|Add to Cart||
|Category Page View||
|Product Detail Page View||
|Remove from Cart||
|Search Page View||
|Shopping Cart View||
|User Log in||
|User Log out||
tealium_event value is always set for the condition that last evaluated to
true. If more than one event condition evaluates to
true, the event lower in the list is set.
The Tealium Events extension provides a list of predefined events. A custom event uses a value defined by you and assigned to the variable
tealium_event. Define these custom events directly in your data layer or by using the Set Data Values extension.
Position custom events defined in an extension after the Tealium Events extension.
To define a custom event using an extension:
- Add a Set Data Values extension.
- Drag the new extension below the existing Tealium Events extension to ensure it runs after it.
- In the Set drop-down list select
- In the text field type the name of your custom event.
- Add a condition to identify your custom event.
Example of custom event using the Set Data Values extension:
The goal of the extension is to standardize the event name value into the
tealium_event variable used in your configuration. Here are some uses for this variable:
Event mappings in tags
Simplify tag configurations that support page and event mappings by using a single variable,
tealium_event, to configure these events.
Load rules use
tealium_event to simplify their conditions.
Customer Data Hub
If you have the Tealium Collect tag all the variables in your data layer are passed along to Tealium EventStream, including
tealium_event. This variable is made available as an imported event attribute to be used in enrichments, rules, and feeds.
Thank you for your feedback!
This page was last updated: February 21, 2023