Events track meaningful user interactions (such as purchase, add to cart, form completion, or rating a product), so you can use the information for behavioral targeting, reporting, setting optimization goals, recommendations, and audience building. Every time one of the defined behaviors occurs, an event is "fired" to Dynamic Yield, enabling the system to use the information in your personalization program.
You can implement events on your website through the Dynamic Yield script, by including a short snippet in your code, or call them using our server-side Experience API.
For event schema, API endpoints, request structure, and code examples, see the Dynamic Yield developer docs: Reporting Events and Events List.
Standard events
The following is a list of predefined events, their description, and what personalization capabilities they enhance.
|
Event |
Description |
|---|---|
|
Purchase Required for e-commerce See developer details |
The user made a purchase. Purchases are often used as optimization goals. They contribute to the user's affinity profile and are used in calculating recommendations. |
|
Add to Cart Required for e-commerce See developer details |
The user added an item to the cart. Adding items to the cart is often used as an optimization goal, and contributes to the user's affinity profile. |
|
Application Required for financial institutions
See developer details |
The user started the application process for a product. Applications are often used as optimization goals, and contribute to the user's affinity profile. |
|
Submission Required for financial institutions See developer details |
The user submitted an application. Submissions are often used as optimization goals. They contribute to the user's affinity profile and are used in calculating recommendations. |
|
Remove from Cart See developer details |
The user removed a product from the cart. |
|
Sync Cart See developer details |
This event updates the current cart state. |
|
Add to Wishlist See developer details |
The user added a product to their Wishlist. This event also impacts the user's affinity profile. |
|
Login See developer details |
Indicates that a user has logged in. |
|
Signup See developer details |
The user completed the signup process. |
|
Identify User See developer details |
Use to identify visitors at any point during their journey on your website, such as during the checkout process. |
|
Newsletter Subscription See developer details |
The user subscribed to a newsletter. |
|
The Login, Signup, Identify User, and Newsletter Subscription events are all used to connect the current device and session to the user's profile, allowing for a unified multi-channel experience. Each of the events must include the unique identifier that is being used in this section, which could be either a hashed email address, a hashed phone number, or a custom ID. |
|
|
Message Opt-in Message Opt-out |
Mark an individual user's email address or phone number to receive or not receive triggered messages. The message recipient list is managed by Dynamic Yield using these events. |
|
Inform Affinity |
Reports product-related affinity information that was supplied by the user, to temporarily boost their affinity score for those product attributes. Learn more |
|
Keyword Search See developer details |
The user ran a free-style keyword search. The event should include the searched words. |
|
Filter Items See developer details |
The user filtered the product list by a specific field value. This event also impacts the user's affinity profile. |
|
Sort Items |
The user changed the sorting order of a product list. |
|
Change Attribute See developer details |
The user changed an attribute of the displayed product (category, color, keyword). |
|
Promo Code Entered |
The user entered a valid promo code. |
|
Video Watch See developer details |
The user watched a video (in part or in full). You can distinguish between auto-playing videos and those the user clicked to watch. |
Custom events
If you want to track user actions that are not in our standard event list, you can create a custom event, and implement it via script or server-side API. Custom events can be anything users do on your site or app: Rate a product, enter a review, click zoom to enlarge a product image, make a donation, select a delivery method, join a VIP club, and so much more.
You can also fire custom events from off-site or websites without the Dynamic Yield script (for example, third-party websites) using a pixel. Note that the window for attributing off-site events to a campaign cannot be a session, but rather must be 1 or 7 days.
Tip: As an alternative to adding code to your site, you can use a template called Fire Event in Custom Code campaigns to fire an event without making any code changes. Learn more about using this template.