CleverTap

Last updated on Dec 03, 2024

Prerequisites

The project credentials are available to provide Hevo access to your CleverTap data.
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.

Obtaining the CleverTap Project Credentials

You require the CleverTap project credentials, namely, the project ID and the passcode, to authenticate Hevo on your CleverTap account.

To obtain your CleverTap project ID and passcode:

Log in to your CleverTap account.
Click the Expand chevron (drop-down icon) at the top of the left navigation pane.
From the Your Projects list, select the project from which you want to ingest data.
In the left navigation pane, click Settings.
In the Settings pane, click Project.
On the Project page, Details tab, scroll down to the section where the project details are displayed.
Click View next to Project ID and copy the ID.
Click View next to Passcode and copy the passcode.

Use this project ID and passcode while configuring your Hevo Pipeline.

Downloading the CleverTap Events File

To download your CleverTap Events file:

Follow steps 1-4 from the above section.
In the Settings pane, click Schema, and then click Events.
On the Events page, System events tab, click Download as CSV.
In the pop-up window that is displayed, select Events and click Download.

Upload this CSV file in Hevo while configuring your Pipeline.

Identifying the Account Region

To identify the region of your CleverTap account, check the URL of your account. The following table lists the regions corresponding to various CleverTap account URLs:

CleverTap Account URL	Region
https://eu1.dashboard.clevertap.com/login.html	EU
https://in1.dashboard.clevertap.com/login.html	India
https://us1.dashboard.clevertap.com/login.html	US
https://sg1.dashboard.clevertap.com/login.html	Singapore
https://aps3.dashboard.clevertap.com/login.html	Indonesia
https://mec1.dashboard.clevertap.com/login.html	Middle East (UAE)

Note: Hevo only supports EU and US regions.

Configuring CleverTap as a Source

Perform the following steps to configure CleverTap as the Source in your Pipeline:

Click PIPELINES in the Navigation Bar.
Click + CREATE PIPELINE in the Pipelines List View.
On the Select Source Type page, select CleverTap.
On the Configure your CleverTap Source page, specify the following:
- Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.
- Project ID: The unique ID of your CleverTap project from your CleverTap account.
- Project Passcode: The passcode for your CleverTap project that you obtained from your CleverTap account.
  
  Note: CleverTap APIs do not return an error when you provide a wrong project ID. Hence, TEST CONNECTION might succeed even with a wrong project ID.
- Region: The region where your CleverTap account is configured. Default region: EU.
- Events File: The CSV file containing the list of all the CleverTap events to be ingested. This is required as CleverTap does not provide any API to list all distinct event names or to download all events at one go.
Click TEST & CONTINUE.
Proceed to configuring the data ingestion and setting up the Destination.

Data Replication

For Teams Created	Default Ingestion Frequency	Minimum Ingestion Frequency	Maximum Ingestion Frequency	Custom Frequency Range (in Hrs)
Before Release 2.21	30 Mins	5 Mins	24 Hrs	1-24
After Release 2.21	6 Hrs	30 Mins	24 Hrs	1-24

Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.

Hevo uses CleverTap’s Get Events API to fetch records from the Events object in CleverTap.

Historical Data: In the first run of the Pipeline, Hevo ingests the data of the past 30 days for the Events object in your CleverTap account.
Incremental Data: Once the historical load is complete, data is ingested as per the ingestion frequency in Full Load or Incremental mode, as applicable.

Note:

CleverTap’s Get Events API returns duplicate data for some Events. Read Schema and Primary Keys to understand how Hevo handles this.
You can also fetch data from CleverTap in real-time using a Pipeline with a Webhook Type Source in Hevo and use CleverTap webhooks with it.

Schema and Primary Keys

Hevo uses CleverTap’s Get Events API to ingest a single object, Events.

The following table lists the schema for the attributes of the Events object used to fetch data from your CleverTap account:

Field	Description	Type
objectId	Represents the CleverTap ID of the user.	String
profileData	Represents all the custom profile properties of the user.	JSON
identity	Represents the custom user ID provided by the user.	String
ts	Represents the event timestamp in the yyyyMMddHHmmSS format.	Timestamp
event_props	Represents the Event properties and their values.	JSON
session_props	Represents the session properties and their values. These are only provided if they were set.	JSON
session_source	Represents the value of a `session_props` attribute.	String

Hevo does not receive any primary key in the response from the Get Events API. Hence, Hevo creates its own primary key, __hevo_id, by hashing the Event’s data and its timestamp. This helps to override any duplicate data received from the API, however, it can result in differences in the count of Events between the Source and the Destination. If you want to replicate the data as is, with possible duplicate records, enable the Append Rows on Update option in the Destination configuration.

Additional Information

Read the detailed Hevo documentation for the following related topics:

Source Considerations

Source Considerations

CleverTap’s Get Events API currently does not support download of the following notifications-related Events:
- Notification Sent
- Notification Bounce
- Notification Viewed
- Notification Control Group
- Notification Rendered
- Notification System Control Group
To ingest these Events, you can try an AWS S3 Export and then, create a Pipeline with Amazon S3 as the Source. This approach also allows you to build Transformations, if needed.
Event names in CleverTap are case-sensitive. For example, Tutorial Complete and tutorial complete are two different CleverTap events. Hence, if you create the CleverTap events file instead of downloading it, you must ensure that the event names in it are exactly the same as those in CleverTap. In case of a mismatch, Hevo is unable to ingest data from the Source.

Revision History

Refer to the following table for the list of key updates made to this page:

Date	Release	Description of Change
Mar-05-2024	2.21	Updated the ingestion frequency table in the Data Replication section.
Oct-03-2023	NA	Added sections, Obtaining the CleverTap Project Credentials and Identifying the Account Region.
Jan-10-2023	2.05	- Updated section, Data Replication to mention about custom ingestion frequency. - Updated section, Source Considerations to add information about CleverTap event names.
Dec-07-2022	NA	Updated section, Data Replication to reorganize the content for better understanding and coherence.
Jun-09-2022	1.90	- Modified the section, Configuring CleverTap as a Source to reflect the latest UI changes. - Added section, Downloading the CleverTap Events File.
May-11-2022	NA	Added a Source consideration about CleverTap’s Get Events API not supporting the export of some notification-related Events.
Nov-22-2021	1.76	- Updated the section, Data Replication to add information about duplicate data returned by CleverTap’s Get Events API. - Updated the section, Schema and Primary Keys to add information about the primary key, `__hevo_id`, and how it helps to avoid duplicate data in the Destination.
Oct-25-2021	NA	Added the Pipeline frequency information in the Data Replication section.
August-23-2021	1.70	- Updated the Data Replication section with details of the historical sync duration and the incremental data ingestion schedule. - Added the section, Schema and Primary Keys.