The Events Settings page is where you configure and manage the core tracking mechanisms of your Optimove site. It is divided into two main sections: Events, where you define the specific customer actions you want to track, and Configuration Files, where you manage the technical setup that enables this tracking on your website and mobile apps.
Prerequisites
- You must have an Admin role to view and manage the Events Settings.
Navigating to Events Settings
- Click the Settings icon in the main navigation menu.
- Under the General Settings category, select Events.
A Guide to the Events Settings Screen
The page is organized into two tabs: Events and Configuration Files.
Managing Events
This tab allows you to create, view, and manage the specific events used to trigger campaigns and track user actions, such as "App Login" or "Added to Wishlist".
- Search: Use the search bar to find a specific event by name.
- Event List: Displays all configured events with their user-friendly Event Name, machine-readable Event Key, and functional Type.
Using the Events Log
The Events Log is a powerful debugging tool that helps you diagnose issues with your event tracking. To access it, click the "Event Log" link from the main Events tab.
By default, and due to the large volume of events, the log automatically records only invalid events to help you quickly identify and fix tracking errors. This does not affect event tracking elsewhere in the app.
Key features of the Events Log include:
- Record All Events: Click this button to temporarily record all events (both valid and invalid) for a short period, which is useful for comprehensive real-time debugging.
- Filtering and Search: You can search the log, add custom filters, and select a specific date range (e.g., Last 7 days) to find the exact events you're looking for.
- Detailed Error Information: The log table provides detailed information for each invalid event, including the time, origin (e.g., SDK), and specific validation errors, such as which mandatory parameters are missing from an event call.
How to Create a New Event
- From the Events tab, click the blue + Add Event button.
- Fill in the event details on the "New Event" screen:
- Event display name: The user-friendly name that will appear in reports and campaign setups (e.g., "Product Added to Cart").
- Event Key: A unique, machine-readable key for the event, created from the Event display name (e.g., "added_to_cart").
- Type: Select the event type that best matches the user action.
- Simple event: An action that typically happens once or marks a key milestone (e.g., "Registered").
- Repeated event: An action that a user can perform multiple times (e.g., "Purchase", "App Opened").
- Uncompleted sequence: An event that is the first part of a two-step action, where the second step was not completed (e.g., "Added to Cart" without a "Purchase").
Adding Parameters to an Event (Optional)
Parameters allow you to send additional data with your event for more powerful segmentation and personalization.
- In the "New Event" screen, click the + Add Parameter link.
- Fill in the parameter details:
- Parameter display name: The user-friendly name for the parameter (e.g., "Product Category").
- Parameter key: The unique, machine-readable key (e.g.,
product_category). - Type: Select the data type: String (for text), Boolean (for true/false values), or Number.
- Click Save on the parameter screen. You can repeat this process to add multiple parameters.
- Once you have added all necessary parameters, click Save on the "New Event" screen to finalize the event.
How to Edit or Delete an Event
- From the event list, click the pencil icon (
✎) on the right-hand side of the event you wish to modify. - On the "Edit Event" screen, you can update any of the fields as described above.
- To permanently remove the event, click the Delete Event link in the top-right corner.
- Click Save to apply your changes.
Configuration Files
This tab contains the high-level technical setup that allows Optimove's tracking to function on your website or mobile application.
These foundational settings are established by your technical team, in collaboration with Optimove, during the initial onboarding process. As such, they do not require changes for day-to-day operations.
If you are planning to make changes to your site's infrastructure or launch a new website or mobile app, please contact your Customer Success Manager or the Optimove support team. They will guide you through the process to ensure your event tracking is configured correctly.