clevertap-web

Wrapper to integrate CleverTap Web SDK with any SPA (React, Vue, Angular).

Note: Events will not be caputed on localhost, events are only captured on production.

• Implementation Example (React) React-CleverTap-Example

Usage

• Installation npm install -D clevertap-web
• Initialize in your root

1import CleverTapWeb from 'clevertap-web';
2
3CleverTapWeb.initialize('CLEVERTAP_ACCOUNT_ID');

API

• Identify Users

1import CleverTapWeb from 'clevertap-web';
2
3// with the exception of one of Identity, Email, or FBID
4// each of the following fields is optional
5
6CleverTapWeb.onUserLogin({
7  Site: {
8    Name: 'Jack Montana', // String
9    Identity: 61026032, // String or number
10    Email: 'jack@gmail.com', // Email address of the user
11    Phone: '+14155551234', // Phone (with the country code)
12    Gender: 'M', // Can be either M or F
13    DOB: new Date(), // Date of Birth. Date object
14    // optional fields. controls whether the user will be sent email, push etc.
15    'MSG-email': false, // Disable email notifications
16    'MSG-push': true, // Enable push notifications
17    'MSG-sms': true, // Enable sms notifications
18    'MSG-whatsapp': true, // Enable WhatsApp notifications
19  },
20});

• Push Event

1import CleverTapWeb from 'clevertap-web';
2
3var payload = {
4  'Product name': 'Casio Chronograph Watch',
5  Category: 'Mens Accessories',
6  Price: 59.99,
7};
8
9CleverTapWeb.event('Product Viewed', payload);
10
11// Payload is optional, if you dont want to pass it, you can just do
12CleverTapWeb.event('Product Viewed');

• Profile Push

1import CleverTapWeb from 'clevertap-web';
2
3var payload = {
4  Site: {
5    Name: 'Jack Montana', // User's name
6    Age: 28,
7  },
8};
9
10CleverTapWeb.profile(payload);

• Logout

1import CleverTapWeb from 'clevertap-web';
2
3CleverTapWeb.logout();