You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/clevertap/index.md
+16-15Lines changed: 16 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,13 @@
1
1
---
2
2
title: CleverTap Destination
3
3
id: 5711271880412f644ff13150
4
+
cmode-override: true
4
5
---
5
6
## Getting Started
6
7
7
8
Once the Segment library is integrated, toggle CleverTap on in your Segment destinations, and add your CleverTap Account ID and CleverTap Account Token which you can find in the CleverTap Dashboard under Settings.
8
9
9
-
You can integrate CleverTap using a server-side or mobile destination (iOS or Andriod). If you are interested in using CleverTap's push notifications or in-app notifications products, you should use the mobile destinations.
10
+
You can integrate CleverTap using a server-side or mobile destination (iOS or Android). If you are interested in using CleverTap's push notifications or in-app notifications products, you should use the mobile destinations.
10
11
11
12
All server-side destination requests require either a Segment Anonymous ID or a userId in the payload.
12
13
@@ -15,7 +16,7 @@ CleverTap supports the `identify`, `track`, `page` (server-side only), and `scre
15
16
16
17
## Identify
17
18
18
-
When you identify a user, we'll pass that user's information to CleverTap with userId as CleverTap's Identity value. A number of Segment's special traits map to CleverTap's standard user profile fields. You'll pass the key on the left into Segment and we will transform it to the key on the right before sending to CleverTap.
19
+
When you identify a user, Segment passes that user's information to CleverTap with userId as CleverTap's Identity value. A number of Segment's special traits map to CleverTap's standard user profile fields. You'll pass the key on the left into Segment and Segment transforms it to the key on the right before sending to CleverTap.
19
20
20
21
-`name` maps to `Name`
21
22
-`birthday` maps to `DOB`
@@ -24,28 +25,28 @@ When you identify a user, we'll pass that user's information to CleverTap with u
24
25
-`phone` maps to `Phone`
25
26
-`email` maps to `Email`
26
27
27
-
All other traits will be sent to CleverTap as custom attributes. Please also note that the default logic will lower case and snake_case any user traits - custom or special - passed to CleverTap.
28
+
All other traits will be sent to CleverTap as custom attributes. The default logic will lower case and snake_case any user traits - custom or special - passed to CleverTap.
28
29
29
30
## Track
30
31
31
-
When you `track` an event, we will send that event to CleverTap as a custom event. Note that CleverTap does not support arrays or nested objects for custom track event properties.
32
+
When you `track` an event, Segment sends that event to CleverTap as a custom event. Note that CleverTap does not support arrays or nested objects for custom track event properties.
32
33
33
34
> note ""
34
35
> CleverTap requires `identify` traits such as `userId` or `email` to record and associate the Track event. Without these traits, the Track event does not appear in CleverTap.
35
36
36
-
Please also note that the default logic for our cloud mode connection to CleverTap will lower case and snake_case any event properties passed from Segment's servers to CleverTap. Our device mode connection will not lower case or snake_case any event properties passed directly to CleverTap from the client.
37
+
The default logic for the cloud mode connection to CleverTap will lower case and snake_case any event properties passed from Segment's servers to CleverTap. The device mode connection will not lower case or snake_case any event properties passed directly to CleverTap from the client.
37
38
38
39
### Order Completed
39
40
40
-
When you `track` an event using the server-side destination with the name `Order Completed` using the [e-commerce tracking API](/docs/connections/spec/ecommerce/v2/), we will map that event to CleverTap's [Charged](https://support.clevertap.com/docs/working-with-events.html#recording-customer-purchases) event.
41
+
When you `track` an event using the server-side destination with the name `Order Completed` using the [e-commerce tracking API](/docs/connections/spec/ecommerce/v2/), Segment maps that event to CleverTap's [Charged](https://support.clevertap.com/docs/working-with-events.html#recording-customer-purchases){:target="_blank"} event.
41
42
42
43
## Page
43
44
44
-
When you send a `page` event using the server-side destination, we will send that event to CleverTap as a Web Page Viewed event.
45
+
When you send a `page` event using the server-side destination, Segment sends that event to CleverTap as a Web Page Viewed event.
45
46
46
47
## Screen
47
48
48
-
When you send a `screen` event using the server-side destination or the iOS bundled SDK, we will send that event to CleverTap as an App Screen Viewed event.
49
+
When you send a `screen` event using the server-side destination or the iOS bundled SDK, Segment sends that event to CleverTap as an App Screen Viewed event.
49
50
50
51
## Android
51
52
@@ -55,7 +56,7 @@ When you send a `screen` event using the server-side destination or the iOS bund
No further action is required to integrate in-app notifications, which are registered for and requested by default by our CleverTap Segment integration.
103
+
No further action is required to integrate in-app notifications, which are registered for and requested by default by the CleverTap Segment integration.
103
104
104
105
105
106
### Sample App
106
107
107
-
CleverTap has created a sample Android application that integrates CleverTap using Segment. Check it out at the [GitHub repo](https://github.com/CleverTap/clevertap-segment-android-example).
108
+
CleverTap has created a sample Android application that integrates CleverTap using Segment. Check it out at the [GitHub repository](https://github.com/CleverTap/clevertap-segment-android-example){:target="_blank"}.
108
109
109
110
## iOS
110
111
@@ -116,7 +117,7 @@ CleverTap has created a sample Android application that integrates CleverTap usi
116
117
`pod 'Segment-CleverTap'`
117
118
```
118
119
119
-
We recommend using the latest version on [CocoaPods](https://cocoapods.org/pods/Segment-CleverTap) since it will contain the most up to date features and bug fixes.
120
+
Use the latest version on [CocoaPods](https://cocoapods.org/pods/Segment-CleverTap){:target="_blank"} since it will contain the most up to date features and bug fixes.
120
121
121
122
2. Next, declare CleverTap's integration in your app delegate instance:
122
123
@@ -144,11 +145,11 @@ CleverTap has created a sample Android application that integrates CleverTap usi
144
145
145
146
### In-App Notifications
146
147
147
-
No further action is required to integrate in-app notifications, which are registered for and requested by default by our CleverTap Segment integration.
148
+
No further action is required to integrate in-app notifications, which are registered for and requested by default by the CleverTap Segment integration.
148
149
149
150
### Sample App
150
151
151
-
CleverTap has created a sample iOS application that integrates CleverTap using Segment. Check it out at the [GitHub repo](https://github.com/CleverTap/clevertap-segment-ios/tree/master/Example).
152
+
CleverTap has created a sample iOS application that integrates CleverTap using Segment. Check it out at the [GitHub repository](https://github.com/CleverTap/clevertap-segment-ios/tree/master/Example){:target="_blank"}.
0 commit comments