On This Page
CleverTap is an omni-channel platform used by companies to engage and retain their customers across industry domains such as travel, fin-tech, e-commerce, food-tech and hospitality.
You can load your CleverTap Events to a Destination system using Hevo Pipelines.
CleverTap API credentials to provide Hevo access to your CleverTap account. Read about Getting your CleverTap API credentials.
Note: Your email address is not the CleverTap Account ID.
Configuring CleverTap as a Source
Perform the following steps to configure CleverTap as the Source in your Pipeline:
Click PIPELINES in the Asset Palette.
Click + CREATE in the Pipelines List View.
In the Select Source Type page, select CleverTap.
In the Configure your CleverTap Source page, specify the following:
Pipeline Name: A unique name for your Pipeline.
Account ID: Account ID obtained from your CleverTap account.
Passcode: Passcode of your CleverTap account.
Note: CleverTap APIs do not return an error when you provide a wrong Account ID. Hence, Test Connection might succeed even with a wrong Account ID.
Region: Select the region where your CleverTap account is configured.
Events: A comma-separated list of CleverTap events you want to ingest. This is required as CleverTap does not provide an API to list all distinct event names or one to download all events at one go.
Click TEST & CONTINUE.
Proceed to configuring the data ingestion and setting up the Destination.
|Default Pipeline Frequency||Minimum Pipeline Frequency||Maximum Pipeline Frequency|
|1 Hr||1 Hr||3 Hrs|
Hevo uses CleverTap’s Get Events API to fetch, download and ingest raw Events from CleverTap.
From Release 1.79 onwards, Hevo ingests your historical data in reverse order, starting from the latest to the earliest. This enables you to have quicker access to the most recent data. This change applies to all new and existing Pipelines.
Historical Sync Duration: In the first run of the Pipeline, Hevo ingests the historical data of the past 30 days for the
Events object in your CleverTap account.
Incremental Data: The ingestion of incremental data is done once per day due to rate limits imposed by the Get Events API. Hevo fetches the previous day’s data at 3.00 a.m. (UTC) daily.
- CleverTap’s Get Events API returns duplicate data for some Events. Read Schema and Primary Keys to understand how Hevo handles this.
- You can 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,
The following table lists the schema for the attributes of the
Events object used to fetch data from your CleverTap account:
|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
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.
Refer to the following table for the list of key updates made to this page:
|Date||Release||Description of Change|
|Jan-03-2022||1.79||Added information about reverse historical load in the Data Replication section.|
|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,
|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