Events
Overview
Events track what individual actions users perform in your app or website. Some examples of events include a user launching an app, viewing a product, listening to a song, sharing a photo, making a purchase, or favoriting an item.
By tracking events in your app, you can better understand what users are doing. In CleverTap, you can analyze these events in many different ways, such as getting aggregating metrics of a specific event or measuring how a specific event type trends over time. You can also engage with your users based on these events by creating campaigns in CleverTap that are triggered by them.
Event Categories
CleverTap has two categories of events:
- System events: Events recorded automatically after you integrate our SDK.
- Custom events: Events you define and track with our SDK or API.
Event Properties
Events have details that describe the action taking place called properties.
For example, while recording the Product viewed event, you could also store event properties, such as product name, category, and price. Recording event properties will help you discover insights, such as which category of products are more popular, and help you segment users based on which categories or price points they have viewed.
System Events
System events are events recorded automatically after you integrate our SDK.
| Event Type | Description | How Event is Tracked |
|---|---|---|
| App Installed | The event is raised when the user launches the app for the first time | The event is raised when the user launches the app for the first time on any mobile device. There are two cases when this event will be recorded multiple times for a single user. The first case is when a user installs your app, uninstalls it, and then reinstalls it. The second case is when a user clears your app's memory and relaunches it. |
| App Launched | This event is recorded every time a user launches your application. | There are two cases when this event will recorded. The first case is a fresh app launch, which is when an app is launched from a killed state. The second case is when an app is brought to the foreground after 20 minutes of inactivity in the background. |
| App Uninstalled | This event is recorded when a user uninstalls your application. | This event is tracked by sending silent push notifications which is a type of notifications that is not rendered on a user’s device. We send silent push notifications to your entire install base once every 24 hours to track uninstalls. For more information, refer to App Uninstall. |
| UTM Visited | This event is tracked when a user clicks on a link from a marketing campaign that has a UTM parameter defined on it. This event is also tracked when a CleverTap-integrated attribution platform, such as Branch or Apsalar, sends this information to CleverTap. | The UTM Visited event is recorded for your marketing campaigns from external sources, such as Google Adwords or AdRoll. |
| Notification Sent | This event is tracked when a campaign message is sent to a user. This event is always recorded, even if the user does not open or click on the message. This event is recorded for email, mobile push, SMS and web push, campaigns. The Notification Sent event is available on the Event dashboard but it is not displayed on the User Profile. | The event is tracked when the notification is successfully sent from CleverTap to the communication channel you select for your campaign. |
| Notification Viewed | This event is tracked when a user views an email, in-app notification, or a web notification sent from CleverTap. | The CleverTap SDK recognizes when a notification sent via CleverTap is viewed by a user. Notification Viewed is available for email, web push, in-app, web popup, and app inbox. Important Properties: * wzrk_pivot: String value containing an A/B testing campaign's variant name. |
| Notification Clicked | This event is tracked only when a user clicks on a campaign sent via CleverTap. You can track or create a Notification Clicked event for every UTM Visited event that is tracked by CleverTap and not any other provider. There is no separate event storage required for the Notification Clicked event because it is derived from the UTM Visited event. | Recorded when a user clicks on a mobile push, in-app, email, web-popup, or web push message sent via the CleverTap dashboard or through the campaign API. The Android push notifications containing deep links to third-party apps are not tracked. Important Properties: wzrk_pivot: String value containing an A/B testing campaign's variant name. wzrk_c2a: String value containing the action button name of notification clicked events. |
| Push Impressions | This event is tracked when a push notification sent from CleverTap is delivered on a user’s device. The funnels on the Push campaign statistics page reflects the count for this event. | After the toggle for Push Impressions is turned on/setup from settings, the CleverTap SDK starts recording an event whenever a push notification sent via CleverTap is delivered to the user’s device. |
| App Version Changed | This event is raised when a user’s current app version is different from the user’s previous app version. | This event is tracked when the CT App version system property differs from one App Launched event to another. |
| Notification Replied | This event is recorded when a user replies to a WhatsApp message. | This event is raised when the brand receives a reply from the user. |
| Reply Sent | This event is recorded when an agent (CleverTap user) replies to a message from the end user. | This event is raised against the user profile of the end user. |
| State Transitioned | This event is recorded for lifecycle optimizer when a user transitions from one stage to another. | This event is raised whenever a user transitions from one state to another or from unmapped to one of the states in the lifecycle optimization framework. It is meant for internal usage at CleverTap and therefore, unavailable for querying. |
| Session Concluded | This event is recorded to mark the end of a session. Session tracking must be enabled for the event to be tracked. | This event is raised when there is 20 minutes of inactivity after an event is raised for a user. |
| Geocluster Entered | This event is recorded to mark when a device enters a geofence. The event will only be applicable for customers who have the geofence feature enabled for them. | Properties: 1. Cluster ID 2. Cluster name 3. Geofence ID |
| Geocluster Exited | This event is recorded to mark when a device exits a geofence. The event will only be applicable for customers who have the geofence feature enabled for them. | Properties: 1. Cluster ID 2. Cluster name 3. Geofence ID |
| Channel Unsubscribed | This event is raised when an email is not acknowledged. | Properties: 1. Campaign ID: This is the ID of the campaign from which user are updating subscriptions. Campaign Type: Currently only email. 2. Group: Group name from which the user unsubscribed/resubscribed. 3. Identity: The user identity/email address. 4. Variant 5. Type: Valid values are bounced, dropped, and spam. Email IDs which bounce, drop or marked as spam are opted out from future emails 6. Subscription Type: Account level and Profile level. Profile Level: The specific profile is opted out for all email campaigns in the future until they opt in again. Account Level: The specific profile and email address is opted out from all email campaigns. Even if other profiles have that email address, they will not be sent emails in the future because that email address has been unsubscribed at the account level. 7. Reason: Reason which was given by the email provider for the type of the error. For example: "smtp;550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces." |
| Notification Replied | This event is recorded when a user replies to a WhatsApp message. | This event is raised when the brand receives a reply from the user. |
| Notification Delivered | This is an event raised only for WhatsApp. It checks if the WhatsApp notification has reached the end-user. | It is raised when the WhatsApp provider confirms that the notification has reached the end user (double-tick of WhatsApp). |
| Reply Sent | This is an event raised only for WhatsApp. This event is recorded when an agent (CleverTap user) replies to a WhatsApp message from the end user. | This event is raised against the user profile of the end user. |
| App Upgraded | This event is raised when a user’s current app version is different from the user’s previous app version. | This event is tracked when the CT App version system property for an app launch is different from the next app launch. |
| Session Concluded | This event is recorded to mark the end of a session. Session tracking must be enabled for the event to be tracked. | This event is raised when there is 20 minutes of inactivity after an event is raised for a user. |
| State Transitioned | This is an event raised only for Lifecycle Optimizer.This event is recorded when a user transitions from one stage to another. | This event is raised whenever a user is assigned a state or there is a transition from one state to another. It is meant for internal usage at CleverTap and therefore, unavailable for querying. |
| Geocluster Entered | The event is only be applicable if you have enabled the geofence feature. This event is recorded to mark when a device enters a geofence. | The event is tracked whenever a device enters a geofence. |
| Geocluster Exited | The event is only be applicable if you have enabled the geofence feature. This event is recorded to mark when a device exits a geofence. | The event is tracked whenever a device exits a geofence. |
| AB Experiment Rendered | This event indicates that the variant has reached the device. | Event is raised when you are using the Product A/B Tests feature. |
| AB Experiment Rolled Out | This event is raised when the winner variant is sent to all devices. | Event is raised when you are using the Product A/B Tests feature. |
| AB Experiment Stopped | This event is raised when experiment was stopped. | Event is raised when you are using the Product A/B Tests feature. |
| AB Experiment Disqualified | This event is raised when the device is disqualified. | Event is raised when you are using the Product A/B Tests feature. |
| Partner Sync | An event raised for each user profile that is part of cohorts imported from partners like Mixpanel. | The Partner Sync event is raised every time CleverTap receives a cohort sync request from partners like Mixpanel. This event is raised for each user in the cohort sync. |
Debug Events
Debug events are events recorded automatically after you integrate our SDK. These events are raised at certain lifecycle stages in your integration and help you track and manage your integration. These events are available on any profile page and Find People page by adding a parameter to the end of the URL ?showDebugEvents=true.
| Event Name | Description | When is it raised |
|---|---|---|
| Identity Set | This debug event is raised when a new user is identified on a customer’s app or an identified user pushes another identity. | This event monitors the status and data points that are important for the identification and engagement of users. This event is for monitoring and debugging only. |
| Identity Reset | This debug event is raised when a profile is demerged (after demerged, a new profile for every device is created and identities are dropped) either from the dashboard (click on the Profile page to reset identities) or through the Demerge Profile API. | It monitors the reset of identities and handles unnecessary merges. This event is used for monitoring and debugging only. |
| Identity Error | This debug event is raised when an existing identity is associated incorrectly with another identity. The former identity is now declared as invalid for the latter's profile. | This event is for monitoring and debugging when identity merges are invalid. |
| Reachable By | This debug event is raised when a user becomes reachable by a communication channel such as SMS, email, mobile push, or when there are changes to the existing communication channel. | Tracked for a profile when: Push token is added/changed. Email ID is added/changed. * Phone number is added/changed. |
| Push Unregistered | This event tracks the removal of a mobile push token. | This debug event is raised when an existing mobile push token is removed for a profile. Tracked for a profile when: A user logs out of the device and another user logs in. Applicable only if the onUserLogin() method is implemented.When a push token is removed using the pushFcmRegisterationId("token",false) method. Applicable only for Android. |
Custom Events
Custom events are events you define and track with our SDK or API. For more information, refer to the Events in the developer documentation.
Event Metadata Recorded Automatically
For every recorded event, CleverTap records the following standard metadata:
- Information about the user who performed the event.
- Date and time when the event was recorded.
- The number of screens viewed by the user before performing the action.
- The referring site and the source of the user visit if it was from an external source.
In addition, CleverTap keeps the user profiles updated with the latest:
- Geographic information like their city, region, country, and latitude/longitude (if available).
- Browser, device make, or model used to access the website or app.
System Properties
CleverTap tracks the following system properties automatically from the mobile SDK. All the system properties are prefixed by CT indicating that they are provided by CleverTap.
The following properties are tracked automatically on all events:
| System Property | Description |
|---|---|
| CT App Version | This is the current version of your application installed on the user device. |
| CT Latitude | The user location identified by the latitude. |
| CT Longitude | The user location identified by the longitude. |
| CT Source | The source of the event. For example, the event may originate from a Mobile SDK or an API. All possible values: Mobile (Mobile SDK) MobileWeb (Web SDK) Web (Web SDK) API segment appsflyer apsalar branch * System (for events generated by CleverTap) |
The following properties are available on the App Launched event:
| System Property | Description |
|---|---|
| CT App Version | This is the current version of your application installed on the user device. |
| CT Latitude | The user location identified by the latitude. |
| CT Longitude | The user location identified by the longitude. |
| CT OS Version | The operating system of the device. For example, 1.0.0. |
| CT SDK Version | The CleverTap SDK version. For example, 30501. |
| CT Network Carrier | The network carrier of the device. For example, AT&T, Vodafone. |
| CT Network Type | The network type of the device. For example, 4G. |
| CT Connected To WiFi | Indicates if the device is connected to the Wi-FI. |
| CT Bluetooth Version | The Bluetooth version of the device. |
| CT Bluetooth Enabled | Indicates if Bluetooth is enabled on the device. |
| CT Source | The source of the event. For example, the event may originate from a Mobile SDK or an API. All possible values: Mobile (Mobile SDK) MobileWeb (Web SDK) Web (Web SDK) API segment appsflyer apsalar branch * System (for events generated by CleverTap) |
Latitude and Longitude
The system properties latitude and longitude are captured and sent from the SDK only if the user gives consent on your app.
Updated over 1 year ago