CleverTap

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.


Prerequisites

  • The CleverTap project credentials to provide Hevo access to your CleverTap data.

Configuring CleverTap as a Source

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

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select CleverTap.

  4. In the Configure your CleverTap Source page, specify the following:

    CleverTap Settings

    • Pipeline Name: A unique name for your Pipeline.

    • Project ID: The ID obtained from your CleverTap project.

    • Project Passcode: The password for your CleverTap project.

      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.

    • 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. Read Downloading the CleverTap Events File to know how to obtain this file.

  5. Click TEST & CONTINUE.

  6. Proceed to configuring the data ingestion and setting up the Destination.


Downloading the CleverTap Events File

  1. Log in to your CleverTap account.

  2. Click the Expand chevron (drop-down icon) at the top left.

  3. From the Your Projects list, select the project from which you want to ingest data.

    Select your Project

  4. In the left navigation pane, click Settings.

    Click Settings

  5. In the Settings pane, click Schema and select Events from the drop-down.

    Click Events

  6. In the Events page, System events tab, click Download as CSV.

    Click Download as CSV

  7. In the pop-up dialog that is displayed, select Events and click Download.

    Click Download

Upload this CSV file in Hevo to configure CleverTap as a Source.


Data Replication

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.

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.

Note:


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.


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.


See Also


Revision History

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

Date Release Description of Change
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.
Last updated on 09 Jun 2022