https://github.com/clevertap/parse-migrate
Parse to CleverTap Push Notification Migration Guide
https://github.com/clevertap/parse-migrate
Last synced: 7 months ago
JSON representation
Parse to CleverTap Push Notification Migration Guide
- Host: GitHub
- URL: https://github.com/clevertap/parse-migrate
- Owner: CleverTap
- Created: 2016-03-22T00:46:39.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-27T21:39:35.000Z (over 10 years ago)
- Last Synced: 2025-04-13T20:02:25.194Z (over 1 year ago)
- Homepage:
- Size: 5.86 KB
- Stars: 1
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Migrate Your Push Notifications from Parse to CleverTap
### Sign up for CleverTap
[Sign up here](https://clevertap.com/sign-up/). It's free, no credit card required.
### Import your Parse users
[Automatically import your Parse users](https://dashboard.clevertap.com/x/import/parse.html) from your CleverTap dashboard.
### Add CleverTap to your app
* [iOS integration guide](https://support.clevertap.com/integration/ios-sdk/)
* [Android integration guide](https://support.clevertap.com/integration/android-sdk/)
* [Server API guide](https://support.clevertap.com/server/overview/)
#### 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`:
```xml
```
`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:
```xml
;
```
#### 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
```java
clevertap = CleverTapAPI.getInstance(getApplicationContext());
JSONArray channels = (JSONArray ) clevertap.profile.getProperty("channels");
if (channels != null) {
for (int i=0; i Campaigns->Push](https://dashboard.clevertap.com/x/push/notification.html).
##### Via the CleverTap Server API
[Learn more about the CleverTap Server API here](https://support.clevertap.com/server/overview/).
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**
```json
{
"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**
```json
{
"status": "success",
"id": 1457433898,
"estimates": {
"android": 90,
"ios": 300
}
}
```
##### From Cloud Code
If you are running your own instance of [parse-server](https://github.com/ParsePlatform/parse-server), you can use the [CleverTap Node.js module](https://github.com/CleverTap/clevertap-node) to send push notifications from your parse-server. Please [see our fork of the parse-server-example server](https://github.com/CleverTap/parse-server-example) 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](https://dashboard.clevertap.com/x/settings.html)) 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](https://github.com/CleverTap/parse-server-example/blob/master/cloud/main.js)) to send push like this, for example:
```javascript
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
```java
Intent launchIntent = getIntent();
String value = intent.getStringExtra("myCustomKey");
```
You can also specify an object as a custom value. In that case:
```java
try {
Intent launchIntent = getIntent();
String value = intent.getStringExtra("myCustomKey");
JSONObject valueObject = new JSONObject(value);
} catch (JSONException exception) {
}
```
##### iOS
```objc
- (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:
```objc
- (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;
}
}
}
```