Migrate Your Push Notifications from Parse to CleverTap

Sign up for CleverTap

Sign up here. It's free, no credit card required.

Import your Parse users

Automatically import your Parse users from your CleverTap dashboard.

Add CleverTap to your app

• iOS integration guide

• Android integration guide

• Server API guide

Maintaining Continuity of Users During the Transition

When you import your Parse users into CleverTap, a CleverTap user profile will be created for each of your Parse users. Those profiles will include the corresponding push tokens and channel values (and other custom property values) from your Parse user.

Our SDK will be able to match the imported CleverTap user profile with a device user via the Parse Installation Id. To enable this matching, you must add the following flag to your Info.plist/AndroidManifest.xml file when integrating the relevant CleverTap SDK.

AndroidManifest.xml:

<meta-data
    android:name="CLEVERTAP_PARSE"
    android:value="1"/>

Info.plist: Add a key called CleverTapParse as a BOOLEAN truthy value in your .plist file.

With a successful matching, your current user channels and other custom profile properties will be available to your client code.

Android GCM Token Considerations

The default with Parse was to collect Android GCM tokens using the Parse GCM Sender Id. As a result, those tokens will no longer work (when you switch to a new provider or Parse ceases operations). If you do not have tokens generated with your own GCM Sender Id, our suggestion is to run CleverTap and Parse side by side in your app for a reasonable time period during which you can generate new tokens using your own GCM Sender Id.

The easiest way to run CleverTap side by side with Parse temporarily is to declare both the Parse and CleverTap broadcast receivers in your AndroidManifest.xml:

<meta-data
    android:name="GCM_SENDER_ID"
    android:value="id:${appGCMSenderId}"/>

<meta-data android:name="com.parse.push.gcm_sender_id"
    android:value="id:${appGCMSenderId}" />;

<receiver android:name="com.parse.GcmBroadcastReceiver"
    android:permission="com.google.android.c2dm.permission.SEND">
    <intent-filter>
        <action android:name="com.google.android.c2dm.intent.RECEIVE" />
        <action android:name="com.google.android.c2dm.intent.REGISTRATION" />
        <category android:name="${appGcmPackage}" />
    </intent-filter>
</receiver>

<receiver
    android:name="com.clevertap.android.sdk.GcmBroadcastReceiver"
    android:permission="com.google.android.c2dm.permission.SEND">
    <intent-filter>
        <action
            android:name="com.google.android.c2dm.intent.RECEIVE"/>
        <action
            android:name="com.google.android.c2dm.intent.REGISTRATION"/>
        <category android:name="${appGcmPackage}"/>
    </intent-filter>
</receiver>

Managing Channels

Your users' current Parse channels will be imported and sync'd to the corresponding CleverTap user profile and will be available to your client-side code.

Android

Accessing Channels

clevertap = CleverTapAPI.getInstance(getApplicationContext());
JSONArray channels = (JSONArray ) clevertap.profile.getProperty("channels");
if (channels != null) {
    for (int i=0; i <channels.length(); i++) {
        try {
            Log.d("Channel", "value is " + channels.get(i));
        } catch (JSONException e) {
            // no-op
        }
    }
}

Adding or Removing Channels

clevertap = CleverTapAPI.getInstance(getApplicationContext());
clevertap.profile.addMultiValueForKey("channels", "mets");

clevertap = CleverTapAPI.getInstance(getApplicationContext());
clevertap.profile.removeMultiValueForKey("channels", "yankees");

iOS

Accessing Channels

NSArray *channels = [[CleverTap sharedInstance] profileGet:@"channels"];
if (channels && [channels isKindOfClass:[NSArray class]]) {
    for (NSString *channel in channels) {
        NSLog(@"channel is %@", channel);
    }
}

Adding or Removing Channels

[[CleverTap sharedInstance] profileAddMultiValue:@"yankees" forKey:@"channels"];

[[CleverTap sharedInstance] profileRemoveMultiValue:@"mets" forKey:@"channels"];

Sending Push Notifications

From the CleverTap Dashboard

You can create and manage push notification campaigns directly in your CleverTap Dashboard->Campaigns->Push.

Via the CleverTap Server API

Learn more about the CleverTap Server API here.

In this example we are creating a push notification to be sent to users subscribed to the "yankees" and "mets" channels.

Endpoint: https://api.clevertap.com/1/targets/create.json

Sample Request

curl -H "Content-Type:application/json"
     -H "X-CleverTap-Account-ID: Your CleverTap Account ID"
     -H "X-CleverTap-Passcode: Your CleverTap Account Passcode"
     --data "@payload"
     "https://api.clevertap.com/1/targets/create.json"

Payload

{
    "name": "My API Campaign",
    "where": {
        "common_profile_prop": {
            "profile_fields": [
                {
                    "name": "channels",
                    "value": ["yankees", "mets"]
                }
            ]
        }
    },
    "content":{
        "title": "Breaking News",
        "body": "Yankees Win 5-4",
        "platform_specific": {
            "ios": {
                "deep_link": "example.com",
                "sound_file": "example.caf",
                "category": "reactive",
                "badge_count": 1,
                "key": "value_ios"
            },
            "android": {
                "background_image": "http://example.jpg",
                "default_sound": true,
                "deep_link": "example.com",
                "key": "value_android"
            }
        }
    },
    "devices": [
        "android",
        "ios",
    ],
    "when": "now"
}

Response

{
    "status": "success",
    "id": 1457433898,
    "estimates": {
        "android": 90,
        "ios": 300
    }
}

From Cloud Code

If you are running your own instance of parse-server, you can use the CleverTap Node.js module to send push notifications from your parse-server. Please see our fork of the parse-server-example server for more details and usage.

• install the CleverTap Node module: npm install --save clevertap

• add your CleverTap Account ID and CleverTap Account Passcode (you can find these in CleverTap Dashboard->Settings) as environment variables (CLEVERTAP_ACCOUNT_ID and CLEVERTAP_ACCOUNT_PASSCODE, respectively).

You can then enable CleverTap in your Cloud Code (see our example cloud/main.js implementation) to send push like this, for example:

const CleverTap = require("clevertap");
const clevertap = CleverTap.init(process.env.CLEVERTAP_ACCOUNT_ID, process.env.CLEVERTAP_ACCOUNT_PASSCODE);

Parse.Cloud.define('push', function(req, res) {
    
    /**
    * Send an immediate push to users subscribed to the specified channels
    */

    const channels = req.params.channels;

    if (!channels) {
        res.error("channels not present");
        return;
    }

    const payload = {
        "name": "test push " + Math.round(new Date().getTime()/1000),
        "when": "now",
        "where": {
            "common_profile_prop": {
                "profile_fields": [{"name": "channels", "value": channels}]
            }
        },
        "content": {
            "title":"Hello!",
            "body":"Just testing"
        },
        "devices": ["ios", "android"]
    }

    clevertap.targets(clevertap.TARGET_CREATE, payload, {"debug":1}).then((r) => {
        res.success(r);
    });
});

Parse.Cloud.afterSave('GameScore', function(req) {
    /**
     * Send all users an immediate push notifiying them of a new Game Score. 
     *
     */
    const gameScore = req.object;
    const body = (gameScore) ? `New Game Score: ${gameScore.get("playerName")} ${gameScore.get("score")}` : "New Game Score";
    const payload = {
        "name": "test push " + Math.round(new Date().getTime()/1000),
        "when": "now",
        "segment":"all",
        "content": {
            "title": "Hey There!",
            "body": body,
        },
        "devices": ["ios", "android"]
    }

    clevertap.targets(clevertap.TARGET_CREATE, payload, {"debug":1}).then((r) => {
        console.log(r);
    });
});

Accessing Push Notification Payloads

You can access your custom key:value pairs like this:

Android

Intent launchIntent = getIntent();
String value = intent.getStringExtra("myCustomKey");

You can also specify an object as a custom value. In that case:

 try {
    Intent launchIntent = getIntent();
    String value = intent.getStringExtra("myCustomKey");
    JSONObject valueObject = new JSONObject(value);
} catch (JSONException exception) {
}

iOS

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
     NSString *value = [userInfo objectForKey:@"myCustomKey"];
}

You can also specify an object as a custom value. In that case:

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
    NSString *value = [userInfo objectForKey:@"myCustomKey"];
    if (value && [value isKindOfClass:[NSString class]]) {
        NSData *_data = [value dataUsingEncoding:NSUTF8StringEncoding];
        
        NSError *error;
        NSDictionary *valueDict = [NSJSONSerialization JSONObjectWithData:_data options:0 error:&error];
        
        if (error) {
            valueDict = nil;
        }
    }
}