- Introduction
- Getting Started
- Creating an Account in Hevo
- Subscribing to Hevo via AWS Marketplace
-
Connection Options
- Connecting Through SSH
- Connecting Through Reverse SSH Tunnel
- Connecting Through VPN
- Connecting Through Mongo PrivateLink
- Connecting Through AWS Transit Gateway
- Connecting Through AWS VPC Endpoint
- Connecting Through AWS VPC Peering
- Using Google Account Authentication
- How Hevo Authenticates Sources and Destinations using OAuth
- Reauthorizing an OAuth Account
- Familiarizing with the UI
- Creating your First Pipeline
- Data Loss Prevention and Recovery
- Data Ingestion
- Data Loading
- Loading Data in a Database Destination
- Loading Data to a Data Warehouse
- Optimizing Data Loading for a Destination Warehouse
- Deduplicating Data in a Data Warehouse Destination
- Manually Triggering the Loading of Events
- Scheduling Data Load for a Destination
- Loading Events in Batches
- Data Loading Statuses
- Data Spike Alerts
- Name Sanitization
- Table and Column Name Compression
- Parsing Nested JSON Fields in Events
- Pipelines
- Data Flow in a Pipeline
- Familiarizing with the Pipelines UI
- Working with Pipelines
- Managing Objects in Pipelines
- Pipeline Jobs
-
Transformations
-
Python Code-Based Transformations
- Supported Python Modules and Functions
-
Transformation Methods in the Event Class
- Create an Event
- Retrieve the Event Name
- Rename an Event
- Retrieve the Properties of an Event
- Modify the Properties for an Event
- Fetch the Primary Keys of an Event
- Modify the Primary Keys of an Event
- Fetch the Data Type of a Field
- Check if the Field is a String
- Check if the Field is a Number
- Check if the Field is Boolean
- Check if the Field is a Date
- Check if the Field is a Time Value
- Check if the Field is a Timestamp
-
TimeUtils
- Convert Date String to Required Format
- Convert Date to Required Format
- Convert Datetime String to Required Format
- Convert Epoch Time to a Date
- Convert Epoch Time to a Datetime
- Convert Epoch to Required Format
- Convert Epoch to a Time
- Get Time Difference
- Parse Date String to Date
- Parse Date String to Datetime Format
- Parse Date String to Time
- Utils
- Examples of Python Code-based Transformations
-
Drag and Drop Transformations
- Special Keywords
-
Transformation Blocks and Properties
- Add a Field
- Change Datetime Field Values
- Change Field Values
- Drop Events
- Drop Fields
- Find & Replace
- Flatten JSON
- Format Date to String
- Format Number to String
- Hash Fields
- If-Else
- Mask Fields
- Modify Text Casing
- Parse Date from String
- Parse JSON from String
- Parse Number from String
- Rename Events
- Rename Fields
- Round-off Decimal Fields
- Split Fields
- Examples of Drag and Drop Transformations
- Effect of Transformations on the Destination Table Structure
- Transformation Reference
- Transformation FAQs
-
Python Code-Based Transformations
-
Schema Mapper
- Using Schema Mapper
- Mapping Statuses
- Auto Mapping Event Types
- Manually Mapping Event Types
- Modifying Schema Mapping for Event Types
- Schema Mapper Actions
- Fixing Unmapped Fields
- Resolving Incompatible Schema Mappings
- Resizing String Columns in the Destination
- Schema Mapper Compatibility Table
- Limits on the Number of Destination Columns
- File Log
- Troubleshooting Failed Events in a Pipeline
- Mismatch in Events Count in Source and Destination
- Audit Tables
- Activity Log
-
Pipeline FAQs
- Can multiple Sources connect to one Destination?
- What happens if I re-create a deleted Pipeline?
- Why is there a delay in my Pipeline?
- Can I change the Destination post-Pipeline creation?
- Why is my billable Events high with Delta Timestamp mode?
- Can I drop multiple Destination tables in a Pipeline at once?
- How does Run Now affect scheduled ingestion frequency?
- Will pausing some objects increase the ingestion speed?
- Can I see the historical load progress?
- Why is my Historical Load Progress still at 0%?
- Why is historical data not getting ingested?
- How do I set a field as a primary key?
- How do I ensure that records are loaded only once?
- Events Usage
- Sources
- Free Sources
-
Databases and File Systems
- Data Warehouses
-
Databases
- Connecting to a Local Database
- Amazon DocumentDB
- Amazon DynamoDB
- Elasticsearch
-
MongoDB
- Generic MongoDB
- MongoDB Atlas
- Support for Multiple Data Types for the _id Field
- Example - Merge Collections Feature
-
Troubleshooting MongoDB
-
Errors During Pipeline Creation
- Error 1001 - Incorrect credentials
- Error 1005 - Connection timeout
- Error 1006 - Invalid database hostname
- Error 1007 - SSH connection failed
- Error 1008 - Database unreachable
- Error 1011 - Insufficient access
- Error 1028 - Primary/Master host needed for OpLog
- Error 1029 - Version not supported for Change Streams
- SSL 1009 - SSL Connection Failure
- Troubleshooting MongoDB Change Streams Connection
- Troubleshooting MongoDB OpLog Connection
-
Errors During Pipeline Creation
- SQL Server
-
MySQL
- Amazon Aurora MySQL
- Amazon RDS MySQL
- Azure MySQL
- Generic MySQL
- Google Cloud MySQL
- MariaDB MySQL
-
Troubleshooting MySQL
-
Errors During Pipeline Creation
- Error 1003 - Connection to host failed
- Error 1006 - Connection to host failed
- Error 1007 - SSH connection failed
- Error 1011 - Access denied
- Error 1012 - Replication access denied
- Error 1017 - Connection to host failed
- Error 1026 - Failed to connect to database
- Error 1027 - Unsupported BinLog format
- Failed to determine binlog filename/position
- Schema 'xyz' is not tracked via bin logs
- Errors Post-Pipeline Creation
-
Errors During Pipeline Creation
- MySQL FAQs
- Oracle
-
PostgreSQL
- Amazon Aurora PostgreSQL
- Amazon RDS PostgreSQL
- Azure PostgreSQL
- Generic PostgreSQL
- Google Cloud PostgreSQL
- Heroku PostgreSQL
-
Troubleshooting PostgreSQL
-
Errors during Pipeline creation
- Error 1003 - Authentication failure
- Error 1006 - Connection settings errors
- Error 1011 - Access role issue for logical replication
- Error 1012 - Access role issue for logical replication
- Error 1014 - Database does not exist
- Error 1017 - Connection settings errors
- Error 1023 - No pg_hba.conf entry
- Error 1024 - Number of requested standby connections
- Errors Post-Pipeline Creation
-
Errors during Pipeline creation
- PostgreSQL FAQs
- Troubleshooting Database Sources
- File Storage
- Engineering Analytics
- Finance & Accounting Analytics
-
Marketing Analytics
- ActiveCampaign
- AdRoll
- Amazon Ads
- Apple Search Ads
- AppsFlyer
- CleverTap
- Criteo
- Drip
- Facebook Ads
- Facebook Page Insights
- Firebase Analytics
- Freshsales
- Google Ads
- Google Analytics
- Google Analytics 4
- Google Analytics 360
- Google Play Console
- Google Search Console
- HubSpot
- Instagram Business
- Klaviyo v2
- Lemlist
- LinkedIn Ads
- Mailchimp
- Mailshake
- Marketo
- Microsoft Ads
- Onfleet
- Outbrain
- Pardot
- Pinterest Ads
- Pipedrive
- Recharge
- Segment
- SendGrid Webhook
- SendGrid
- Salesforce Marketing Cloud
- Snapchat Ads
- SurveyMonkey
- Taboola
- TikTok Ads
- Twitter Ads
- Typeform
- YouTube Analytics
- Product Analytics
- Sales & Support Analytics
- Source FAQs
- Destinations
- Familiarizing with the Destinations UI
- Cloud Storage-Based
- Databases
-
Data Warehouses
- Amazon Redshift
- Amazon Redshift Serverless
- Azure Synapse Analytics
- Databricks
- Firebolt
- Google BigQuery
- Hevo Managed Google BigQuery
- Snowflake
-
Destination FAQs
- Can I change the primary key in my Destination table?
- How do I change the data type of table columns?
- Can I change the Destination table name after creating the Pipeline?
- How can I change or delete the Destination table prefix?
- Why does my Destination have deleted Source records?
- How do I filter deleted Events from the Destination?
- Does a data load regenerate deleted Hevo metadata columns?
- How do I filter out specific fields before loading data?
- Transform
- Alerts
- Account Management
- Activate
- Glossary
Releases- Release 2.30.2 (Nov 25-Dec 02, 2024)
- Release 2.30.1 (Nov 18-25, 2024)
- Release 2.30 (Oct 21-Nov 18, 2024)
-
2024 Releases
- Release 2.29 (Sep 30-Oct 22, 2024)
- Release 2.28 (Sep 02-30, 2024)
- Release 2.27 (Aug 05-Sep 02, 2024)
- Release 2.26 (Jul 08-Aug 05, 2024)
- Release 2.25 (Jun 10-Jul 08, 2024)
- Release 2.24 (May 06-Jun 10, 2024)
- Release 2.23 (Apr 08-May 06, 2024)
- Release 2.22 (Mar 11-Apr 08, 2024)
- Release 2.21 (Feb 12-Mar 11, 2024)
- Release 2.20 (Jan 15-Feb 12, 2024)
-
2023 Releases
- Release 2.19 (Dec 04, 2023-Jan 15, 2024)
- Release Version 2.18
- Release Version 2.17
- Release Version 2.16 (with breaking changes)
- Release Version 2.15 (with breaking changes)
- Release Version 2.14
- Release Version 2.13
- Release Version 2.12
- Release Version 2.11
- Release Version 2.10
- Release Version 2.09
- Release Version 2.08
- Release Version 2.07
- Release Version 2.06
-
2022 Releases
- Release Version 2.05
- Release Version 2.04
- Release Version 2.03
- Release Version 2.02
- Release Version 2.01
- Release Version 2.00
- Release Version 1.99
- Release Version 1.98
- Release Version 1.97
- Release Version 1.96
- Release Version 1.95
- Release Version 1.93 & 1.94
- Release Version 1.92
- Release Version 1.91
- Release Version 1.90
- Release Version 1.89
- Release Version 1.88
- Release Version 1.87
- Release Version 1.86
- Release Version 1.84 & 1.85
- Release Version 1.83
- Release Version 1.82
- Release Version 1.81
- Release Version 1.80 (Jan-24-2022)
- Release Version 1.79 (Jan-03-2022)
-
2021 Releases
- Release Version 1.78 (Dec-20-2021)
- Release Version 1.77 (Dec-06-2021)
- Release Version 1.76 (Nov-22-2021)
- Release Version 1.75 (Nov-09-2021)
- Release Version 1.74 (Oct-25-2021)
- Release Version 1.73 (Oct-04-2021)
- Release Version 1.72 (Sep-20-2021)
- Release Version 1.71 (Sep-09-2021)
- Release Version 1.70 (Aug-23-2021)
- Release Version 1.69 (Aug-09-2021)
- Release Version 1.68 (Jul-26-2021)
- Release Version 1.67 (Jul-12-2021)
- Release Version 1.66 (Jun-28-2021)
- Release Version 1.65 (Jun-14-2021)
- Release Version 1.64 (Jun-01-2021)
- Release Version 1.63 (May-19-2021)
- Release Version 1.62 (May-05-2021)
- Release Version 1.61 (Apr-20-2021)
- Release Version 1.60 (Apr-06-2021)
- Release Version 1.59 (Mar-23-2021)
- Release Version 1.58 (Mar-09-2021)
- Release Version 1.57 (Feb-22-2021)
- Release Version 1.56 (Feb-09-2021)
- Release Version 1.55 (Jan-25-2021)
- Release Version 1.54 (Jan-12-2021)
-
2020 Releases
- Release Version 1.53 (Dec-22-2020)
- Release Version 1.52 (Dec-03-2020)
- Release Version 1.51 (Nov-10-2020)
- Release Version 1.50 (Oct-19-2020)
- Release Version 1.49 (Sep-28-2020)
- Release Version 1.48 (Sep-01-2020)
- Release Version 1.47 (Aug-06-2020)
- Release Version 1.46 (Jul-21-2020)
- Release Version 1.45 (Jul-02-2020)
- Release Version 1.44 (Jun-11-2020)
- Release Version 1.43 (May-15-2020)
- Release Version 1.42 (Apr-30-2020)
- Release Version 1.41 (Apr-2020)
- Release Version 1.40 (Mar-2020)
- Release Version 1.39 (Feb-2020)
- Release Version 1.38 (Jan-2020)
- Early Access New
- Upcoming Features
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 data from your CleverTap account to a Destination database or data warehouse using Hevo Pipelines.
Hevo requires the Project ID and Project Passcode of your CleverTap project, along with the Events file associated with the project and your account region, to access your data.
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.
-
In 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.
-
In 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.
-
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, 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
-
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.
See Also
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. |