CleverTap

CleverTap is a customer engagement and retention platform that enables customer lifecycle management and mobile marketing services. With CleverTap, you can integrate analytics and marketing all in one place.

Destination Info

Client-sideServer-side

Web

Mobile

Server

Getting Started

Follow these steps to enable the CleverTap destination in Freshpaint:

  1. Navigate to the CleverTap destination page in Freshpaint

  2. Copy your CleverTap Account ID and region from your CleverTap your dashboard's URL and Configure the values in Freshpaint. You can also find the Account ID by going to Project > Details.

  3. That's it! You've now enabled this destination in Freshpaint. Continue following the steps below to use this destination.

Set up User Identification

In order to create user profiles and attribute events to those profiles in CleverTap, you need to have User Identification set up. You can use events and user properties to segment, or cohort users in CleverTap for targeted marketing campaigns. Read more here for user segmentation in CleverTap. See this section below for more on user identification specifically for CleverTap.

Enable the CleverTap Destination for Event(s)

In order to send events to CleverTap, you'll need to enable the CleverTap destination for the desired event in the event definition.

Confirm events are sending successfully to CleverTap

You can see events in CleverTap by going to Analytics > Events and searching by the event name. See the section below for more information on events sent to CleverTap.

Identify

When you call freshpaint.identify(), Freshpaint will create user profile in CleverTap for the user and set properties on their profile. If a userId The following Freshpaint user properties map to CleverTap's standard user profile fields:

Freshpaint User PropertyCleverTap Standard User Profile FieldFormat Restrictions

name

Name

birthday

DOB

Must be a Date object

gender

Gender

Must be "M" or "F"

phone

Phone

email

Email

avatar

Photo

All other user properties will be sent to CleverTap as custom user properties.

It is recommended that you send at least either email or userId to identify a user for CleverTap

Here is an example of an identify call to Freshpaint with properties that would map to CleverTap standard user profile fields:

freshpaint.identify("test_user_id", {
    "email": "john.doe@example.com",
    "name": "John Doe",
    "gender": "M",
    "birthday": "1988-09-28",
    "phone": 5555555555
  }
)

You can search for users under Segments > Find People and search by userId or email

You can segment users in CleverTap by going to Segments > Find People and choosing the desired options you'd like to segment your users by. For example, you can segment users by behavior by finding users who triggered a Freshpaint event sent to CleverTap:

You can learn more about segmenting users and creating cohorts in CleverTap here.

Events

When you send an event to CleverTap from Freshpaint, Freshpaint calls CleverTap's track method from their SDK to create a custom event in CleverTap.

CleverTap does not support nested objects or arrays with events. Event properties kept in arrays or objects will be rejected by CleverTap.

CleverTap requires identify properties such as userId or email to record and associate the event. Without these properties, the Track event does not appear in CleverTap.

Configuration Options

Event Transformations

Set up transformations to modify your data before it's sent to your destination. Read more about transformations here.

Connection Mode Settings

Only client-side connection mode is available for this destination. Events originating from the user's web browser will be sent directly to CleverTap.

Event Limitations

CleverTap has the following event limitations that should be considered:

  • The maximum number of User Event types per application is 512. However, the volume of events submitted per account across those user event types is practically unlimited.

  • For each User Event recorded, the maximum number of Event Properties is limited to 256.

  • ‘Charged’ Event supports up to 256 item values.

  • Event property keys must be of type String and property values must be scalar values, that is, String, Boolean, Integer, Float, or a Date object.

  • Prohibited characters: &, $, “, , %, >, <, !

  • User Event keys are limited to 120 characters in length.

  • User Event property values are limited to 512 characters in length.

Last updated