copyright

lastupdated

keywords

subcollection

years
2022, 2024

2024-10-08

event-notifications, event notifications migration, notifications, destinations, push, migration

event-notifications

Migrating your apps from Push Notifications to {{site.data.keyword.en_short}}

{: #en-migrate-apps}

You can migrate your mobile apps from the deprecated IBM Cloud Push Notifications service to {{site.data.keyword.en_short}} to continue to use Push. {: shortdesc}

Introduction

{: #en-migrate-intro}

{{site.data.keyword.en_short}} is a routing service that tells you about critical events that occur in your {{site.data.keyword.cloud_notm}} account. You can filter and route {{site.data.keyword.en_full}} from {{site.data.keyword.cloud_notm}} services like Monitoring, Security and Compliance Center, and Secrets Manager to communication channels like email, SMS, push notifications, and webhooks.

This guide outlines the steps to migrate your mobile apps and the backend to integrate with the {{site.data.keyword.en_short}} service.

Take the following steps to migrate your mobile apps:

Create and configure an instance of {{site.data.keyword.en_full}}
Modify your Android or iOS mobile app to work with the {{site.data.keyword.en_short}} service
Modify your backend to integrate with the new API of the {{site.data.keyword.en_short}} service
Release the new version of the mobile app

Create and configure an instance of the {{site.data.keyword.en_short}} service

{: #en-migrate-create} {: step}

Create an instance of the {{site.data.keyword.en_short}} service. This procedure does not use any advanced capabilities of the {{site.data.keyword.en_short}} service. Within the service, you create an API source, a topic, a subscription, and a destination as outlined in figure 1.

For a more detailed explanation of the concepts of {{site.data.keyword.en_short}}, see Getting started with {{site.data.keyword.en_full}}.

$Push capability in {{site.data.keyword.en_short}}$ {: caption="Push capability in {{site.data.keyword.en_short}}" caption-side="bottom"}

Create a source

{: #en-migrate-create-source}

Create an API source. This source represents the backend from which you send the notifications.

Create a topic

{: #en-migrate-create-topic}

Create a topic where all the events from the backend flow into. However, this topic does not do any filtering, define a filter that sends all events from the source to this topic.

Create a destination

{: #en-migrate-create-destination}

Create a destination of the required type.

Create a subscription

{: #en-migrate-create-subscription}

Create a subscription from the topic to the destination.

Create service credentials

{: #en-migrate-create-credentials}

Create a set of credentials with the role of “Device Manager”.

Modify an Android mobile application

{: #en-migrate-modify-android} {: step}

Modify the mobile app source code to use the new {{site.data.keyword.en_short}} SDKs. You replace the existing {{site.data.keyword.mobilepushshort}} service SDK with the {{site.data.keyword.en_short}} FCM SDK.

Create an Android destination

{: #en-migrate-create-android-destination}

Create a destination of type Android Push Notification (FCM) for the Android app. Provide the Sender ID and Server Key from your Google console.

{: caption="Create Android destination" caption-side="bottom"}

Modify your project in Firebase console

{: #en-migrate-modify-project-firebase}

The package name for the {{site.data.keyword.mobilepushshort}} SDK was com.ibm.mobilefirstplatform.clientsdk.android.push. The new Event Notification SDK has the package com.ibm.cloud.eventnotifications.destination.android. Update your project in Firebase Console with the new package, then download and replace the new google-services.jsonfile in your Android project.

Go to the Firebase Console

{: caption="Firebase Console" caption-side="bottom"}
Select the project that you are using for {{site.data.keyword.mobilepushshort}}.

{: caption="Select project" caption-side="bottom"}
In the navigation panel, select the Settings icon next to the Project Overview and select Settings > Project settings. Scroll down to locate Your apps.

{: caption="Project setting" caption-side="bottom"}
Find an app with package name com.ibm.mobilefirstplatform.clientsdk.android.push and click Remove this app.
Click Add app > Choose Android
Enter com.ibm.cloud.eventnotifications.destination.android as the package name and click Register App.

{: caption="Register app" caption-side="bottom"}
Download google-services.json. You use this file later when you modify the app.

Edit the Android app

{: #en-migrate-edit-andriod-app}

Add the Firebase google-services.json in the app module.

Change the Module’s build.gradlefileto include the new SDKs.

// Replace the following section

dependencies {
   ........
   implementation 'com.google.firebase:firebase-messaging:20.0.0'
   Implementation 'com.ibm.mobilefirstplatform.clientsdk.android:core:3.+'
   .......
}

// with this

dependencies {
   ........
   implementation platform('com.google.firebase:firebase-bom:29.0.0')
   implementation 'com.google.firebase:firebase-messaging'
   implementation 'com.ibm.cloud:sdk-core:9.15.0'
   implementation 'com.ibm.cloud:eventnotifications-destination-android:0.0.1'
   .......
}

{: codeblock}

Open AndroidManifest.xml and change the following elements:

Change the <service> section to refer to the new service

// Replace the following section

<service android:name="com.ibm.mobilefirstplatform.clientsdk.android.push.api.MFPPushIntentService" android:exported="true" >
   <intent-filter>
      <action android:name="com.google.firebase.MESSAGING_EVENT" />
   </intent-filter>
</service>

<service
android:name="com.ibm.mobilefirstplatform.clientsdk.android.push.api.MFPPush" android:exported="true" >
   <intent-filter>
      <action android:name="com.google.firebase.INSTANCE_ID_EVENT" />
   </intent-filter>
</service>

// with this

<service android:name="com.ibm.cloud.eventnotifications.destination.android.ENPushIntentService" android:exported="true">
   <intent-filter>
      <action android:name="com.google.firebase.MESSAGING_EVENT" />
   </intent-filter>
</service>

<service android:name="com.ibm.cloud.eventnotifications.destination.android.ENPush" android:exported="true" >
   <intent-filter>
      <action android:name="com.google.firebase.INSTANCE_ID_EVENT" />
   </intent-filter>
</service>

{: codeblock}

Change the <activity> section to point to the new class

// Replace the following section

<activity  android:name="com.ibm.mobilefirstplatform.clientsdk.android.push.api.    MFPPushNotificationHandler" android:theme="@android:style/Theme.NoDisplay"/>

// with this

<activity   android:name="com.ibm.cloud.eventnotifications.destination.android.     ENPushNotificationHandler" android:theme="@android:style/Theme.NoDisplay"/>

{: codeblock}

Change the import statements in the code. The new package name is com.ibm.cloud.eventnotifications.destination.android.*. Replace the old push import as shown:

// Replace the following section

import com.ibm.mobilefirstplatform.clientsdk.android.push.api.MFPPush;

// with this

import com.ibm.cloud.eventnotifications.destination.android.ENPush;

{: codeblock}

Initialize the new SDK

// Replace the following section

BMSClient.getInstance().initialize(this, "ibmCloudRegionSuffix");
MFPPush push = MFPPush.getInstance();
push.initialize(getApplicationContext(), "appGUID", "clientSecret");

// with this

String instanceGUID = "<instance_guid>>";
String destinationID = "<instance_destination_id>";
String apiKey = "<instance_apikey>";

ENPush enPush = ENPush.getInstance();
push.setCloudRegion(ENPush.REGION_US_SOUTH); // Set your region

push.initialize(getApplicationContext(),instanceGUID,destinationID, apiKey);

{: codeblock}

There are additional fields like destinationID and apikey in the new initialize() method.

For more information, on getting the apikey for client SDK see Managing service access.

The callback class in the new SDK has changes. Make these changes in the listener.

// Replace the following section

MFPPushNotificationListener notificationListener = new MFPPushNotificationListener() {

   @Override
   public void onReceive (final MFPSimplePushNotification message){
      // Handle Push Notification
   }
};

push.listen(notificationListener)

// with this

ENPushNotificationListener notificationListener = new ENPushNotificationListener() {

      @Override
      public void onReceive (final ENSimplePushNotification message){
         // Handle Push Notification
      }
};

push.listen(notificationListener)

{: codeblock}

Make changes to the device registration step.

If you are registering without userID

   // Replace the following section

push.registerDevice(new MFPPushResponseListener<String>() {

     @Override
     public void onSuccess(String response) {
         //handle successful device registration here
     }

     @Override
     public void onFailure(MFPPushException ex) {
         //handle failure in device registration here
         }
});

// with this

push.registerDevice(new ENPushResponseListener<String>() {

     @Override
     public void onSuccess(String deviceId) {
          //handle successful device registration here
     }

     @Override
     public void onFailure(ENPushException ex) {
          //handle failure in device registration here
     }
});

{: codeblock}

If you are using registerDeviceWithUserId

// Replace the following section

push.registerDeviceWithUserId("userId", new MFPPushResponseListener<String>() {

     @Override
     public void onSuccess(String response) {
         //handle successful device registration here
     }

     @Override
     public void onFailure(MFPPushException ex) {
         //handle failure in device registration here
     }
});

// with this

push.registerDeviceWithUserId("userId",new ENPushResponseListener<String>() {

      @Override
      public void onSuccess(String deviceId) {
          //handle successful device registration here
      }

      @Override
      public void onFailure(ENPushException ex) {
          //handle failure in device registration here
      }
});

{: codeblock}

Make changes to the unregister API call.

// Replace the following section

push.unregister(new MFPPushResponseListener<String>() {

   @Override
   public void onSuccess(String s) {
         // Handle success
   }

   @Override
   public void onFailure(MFPPushException e) {
         // Handle Failure
   }
});

// with this

push.unregister(new ENPushResponseListener<String>() {

      @Override
      public void onSuccess(String s) {
         // Handle success
      }

      @Override
      public void onFailure(ENPushException e) {
         // Handle Failure
      }
});

{: codeblock}

Optionally, if you are using tags

Change the tag subscriptions as follows:

// Replace the following section

push.subscribe("tagName", new MFPPushResponseListener<String>() {

      @Override
      public void onSuccess(String arg) {
         System.out.println("Succesfully Subscribed to: "+ arg);
      }

      @Override
      public void onFailure(MFPPushException ex) {
         String message = ex.getMessage();
         System.out.println("Error subscribing to Tag " + message);
      }
});

// with this

push.subscribe("tagName", new ENPushResponseListener<String>() {

      @Override
      public void onSuccess(String arg) {
         System.out.println("Succesfully Subscribed to: "+ arg);
      }

      @Override
      public void onFailure(ENPushException ex) {
         String message = ex.getMessage();
         System.out.println("Error subscribing to Tag " + message);
      }
});

{: codeblock}

Changes to get all the tag subscription for the device

// Replace the following section

push.getSubscriptions(new MFPPushResponseListener<List<String>>() {

      @Override
      public void onSuccess(List<String> tags) {
         System.out.println("Subscribed tags are: "+tags);
      }

      @Override
      public void onFailure(MFPPushException ex) {
         String message = ex.getMessage();
         System.out.println("Error getting subscriptions " + message);
      }
})

// with this

push.getSubscriptions(new ENPushResponseListener<List<String>>() {

      @Override
      public void onSuccess(List<String> tags) {
         System.out.println("Subscribed tags are: "+tags);
      }

      @Override
      public void onFailure(ENPushException ex) {
         String message = ex.getMessage();
         System.out.println("Error getting subscriptions " +message );
      }
})

{: codeblock}

Make changes to tag unsubscribe

// Replace the following section

push.unsubscribe("tagName", new MFPPushResponseListener<String>() {

   @Override
   public void onSuccess(String s) {
      System.out.println("Successfully unsubscribed from " + tag);
   }

   @Override
   public void onFailure(MFPPushException ex) {
      String message = ex.getMessage();
      System.out.println("Error while unsubscribing from tag "+ message);
   }
});

// with this

push.unsubscribe("tagName", new ENPushResponseListener<String>() {

      @Override
      public void onSuccess(String s) {
         System.out.println("Successfully unsubscribed from tag . "+ tag);
      }

      @Override
      public void onFailure(ENPushException ex) {
         String message = ex.getMessage();
         System.out.println("Error while unsubscribing from "+ message);
      }
});

{: codeblock}

Optionally, if you are using Notification options, make the following changes:

Changes to the Notification actions listener

// Replace the following section

notificationListener = new MFPPushNotificationListener() {
   @Override
   public void onReceive(final MFPSimplePushNotification message) {
      if (message.actionName.equals("Accept Button")){
         System.out.print("Clicked Accept Action");
      } else if (message.actionName.equals("Decline Button")){
         System.out.print("Clicked Decline Action");
      } else if (message.actionName.equals("View Button")){
         System.out.print("Clicked View Action");
      }
   }
};

// with this

notificationListener = new ENPushNotificationListener() {
         @Override
   public void onReceive(final ENSimplePushNotification message) {
      if (message.getActionName().equals("Accept Button")){
            System.out.print("Clicked Accept Action");
      } else if (message.getActionName().equals("Decline Button")){
            System.out.print("Clicked Decline Action");
      } else if (message.getActionName().equals("View Button")){
            System.out.print("Clicked View Action");
      }
   }
};

{: codeblock}

Your Android mobile app is ready to work with your new instance of {{site.data.keyword.en_full}}.

Modify an iOS mobile application

{: #en-migrate-modify-ios} {: step}

Modify the mobile app source code to use the new {{site.data.keyword.en_short}} SDKs. You will replace the existing {{site.data.keyword.mobilepushshort}} service SDK with the {{site.data.keyword.en_short}} FCM SDK.

Create an iOS destination

{: #en-migrate-create-ios-destination}

Create a destination of type Apple Push Notification (APNs) for the iOS app. Provide the P12 or P8 and their configurations.

{: caption="Create iOS destination" caption-side="bottom"}

Edit the iOS application

{: #en-migrate-edit-ios-app}

Follow these steps to migrate from BMPush to ENPushDestination:

Change the import statement

// Replace this

import BMSCore
import BMSPush

// with this

import ENPushDestination

{: codeblock}

Replace SDK Initialization code

// Replace this

let push = BMSClient.sharedInstance

push.initialize(bluemixRegion: "<IBM cloud region>")

push.initializeWithAppGUID(
               appGUID: "<IBM Cloud Push Instance GUID>",
               clientSecret:"<IBM Cloud Push Instance ClientSecret>"
            )

// with this

let instanceGUID = "<IBM-Cloud-en-instance_guid>>";
let destinationID = "<IBM-Cloud-en-instance-destination-id>";
let apiKey = "<IBM-Cloud-en-instance-apikey>";

let push = ENPush.sharedInstance

push.setCloudRegion(region: "<IBM cloud region>")

push.initialize(instanceGUID, destinationID, apiKey)

{: codeblock}

There are extra fields like destinationID and apikey in new initialize() method. For more information, on getting the apikey for client SDK see Managing service access.

Change the device registration step

If you are registering without userID

// Replace this

   push.registerWithDeviceToken(deviceToken: "<apns-device-token>") {
      (response, statusCode, error) -> Void in

         print(response)

   }

   // with this

   push.registerWithDeviceToken(deviceToken: "<apns-device-token>") {
         response, statusCode, error in

            print(response?.id ?? "")
   }

{: codeblock}

If you are using user ID for registration

// Replace this

push.registerWithDeviceToken(deviceToken:("<apns-device-token>",                                                         WithUserId: "<your-user-id>") {
   (response, statusCode, error) -> Void in

      print(response)
}

// with this

push.registerWithDeviceToken(deviceToken: "<apns-device-token>",
                              withUserId: "<your-user-id>") {
   response, statusCode, error in

   print(response)
}

{: codeblock}

Change the unregister API call

// Replace this

push.unregisterDevice(completionHandler: {
   (response, statusCode, error) -> Void in

   print(response)
}

// with this

push.unregisterDevice { response, statusCode, error in
   print(response)
}

{: codeblock}

Optionally, if you are using tags:

Change the tag subscriptions as follows:

// Replace this

push.subscribeToTags(tagsArray: ["<tag_name>"], completionHandler: { (response, statusCode, error) -> Void in

   /**.....*/
}


// with this
push.subscribeToTags(tagName: "<tag_name>") {
   response, statusCode, error in

   /**.....*/
});

Changes to the get all tag subscription for the device

// Replace this

push.retrieveSubscriptionsWithCompletionHandler(completionHandler: { (response, statusCode, error) -> Void in

   /**.....*/
}

// with this

push.retrieveSubscriptionsWithCompletionHandler {
   response, statusCode, error in

   /**.....*/
}

Changes to the tag unsubscribe

// Replace this


push.unsubscribeFromTags(tagsArray: ["<tag_name>"], completionHandler: {
(response, statusCode, error) -> Void in

   /**.....*/
}


// with this

push.unsubscribeFromTags(tagName: "<tag_name>") {
   response, statusCode, error in

   /**.....*/
}

Optionally, if you are using Notification options, make the following changes:

Initialize the class

// Replace this

let notificationOptions = BMSPushClientOptions()
notificationOptions.setInteractiveNotificationCategories(
                     categoryName: [category])
push.initializeWithAppGUID(
      appGUID: "<IBM Cloud Push Instance GUID>",
      clientSecret:"<IBM Cloud Push Instance ClientSecret>",
      options: notificationOptions)


// with this

let notificationOptions = ENPushClientOptions()
notificationOptions.setInteractiveNotificationCategories(
                     categoryName: [category])
enPush.initialize("<instance_guid>",
                  "<instance_destination_id>",
                  "<instance_apikey>",
                  notificationOptions)

Change the Notification button

// Replace this

let acceptButton = BMSPushNotificationAction(
                  identifierName: "Accept",
                  buttonTitle: "Accept",
                  isAuthenticationRequired: false,
                  defineActivationMode:.background)

let rejectButton = BMSPushNotificationAction(
                  identifierName: "Reject",
                  buttonTitle: "Reject",
                  isAuthenticationRequired: false,
                  defineActivationMode: .background)

// with this


let actionOne = ENPushNotificationAction(
               identifierName: "Accept",
               buttonTitle: "Accept",
               isAuthenticationRequired: false,
               defineActivationMode: .foreground)

let actionTwo = ENPushNotificationAction(
               identifierName: "Reject",
               buttonTitle: "Reject",
               isAuthenticationRequired: false,
               defineActivationMode: .destructive)

Change the Notification category

   // Replace this

let category = BMSPushNotificationActionCategory(
               identifierName: "category",
               buttonActions: [acceptButton, rejectButton])

// with this

let category = ENPushNotificationActionCategory(
               identifierName: "category",
               buttonActions: [actionOne, actionTwo])

Your iOS mobile app is ready to work with your new instance of {{site.data.keyword.en_full}}.

Modify a Web application

{: #en-migrate-modify-web} {: step}

Modify the Web app source code to use the new {{site.data.keyword.en_short}} SDKs. You will replace the existing {{site.data.keyword.mobilepushshort}} service WebPush SDK with the {{site.data.keyword.en_short}} WebPush SDK.

Create a Web destination

{: #en-migrate-create-web-destination}

Chrome Destination

{: #en-migrate-create-web-chrome-destination}

Create a destination of type Chrome Push Notification for the Web app. Provide the Website URL and FCM Server key.

{: caption="Create Chrome destination" caption-side="bottom"}

Firefox Destination

{: #en-migrate-create-web-firefox-destination}

Create a destination of type Firefox Push Notification for the Web app. Provide the Website URL.

{: caption="Create Firefox destination" caption-side="bottom"}

Safari Destination

{: #en-migrate-create-web-safari-destination}

Create a destination of type Safari Push Notification for the Web app. Provide the Website name, Website push ID, Website URL, URL format string, p12 file, Password and icons.

{: caption="Create Safari destination" caption-side="bottom"}

Edit the Web application

{: #en-migrate-edit-web-app}

Update your web application with the latest SDK by using the following steps.

Change the import statement.

   // Replace this
   <script src="BMSPushSDK.js" async></script>

   // with this
   <script src="https://github.com/IBM/event-notifications-destination-webpush-sdk/blob/main/ENPushSDK.js" async></script>

{: codeblock}

Replace SDK Initialization code.

   // Replace this

   var bmsPush = new BMSPush()
   function callback(response) {
   	alert(response.response)
   }
   var initParams = {
       "appGUID":"push app GUID",
       "appRegion":"Region where service hosted",
       "clientSecret":"push app client secret",
       "websitePushIDSafari": "website Push ID for safari",
       "deviceId":"Optional deviceId for device registration",
       "applicationServerKey":"VAPID key",
   }
   bmsPush.initialize(params, callback)

   // with this

   var enPush = new ENPush()

   function callback(response) {
     alert(response)
   }

   var  initParams = {
      "instanceGUID": "<IBM-Cloud-en-instance_guid>",
      "apikey": "<IBM-Cloud-en-instance-apikey>"; ,
      "region": "<IBM cloud region>",
      "chromeDestinationId": "<IBM-Cloud-en-instance-chrome-destination-id>",
      "chromeApplicationServerKey": "<IBM-Cloud-en-instance-chrome-vapid>",
      "firefoxDestinationId": "<IBM-Cloud-en-instance-firefox-destination-id>",
      "firefoxApplicationServerKey": "<IBM-Cloud-en-instance-firefox-vapid>",
      "safariDestinationId": "<IBM-Cloud-en-instance-safari-destination-id>",
      "websitePushIdSafari": "<safari-web-push-id>"
   }

   enPush.initialize(initParams, callback)

BMSPushSDK.js

Change the device registration step

If you are registering without userID

// Replace this
bmsPush.register(function(response) {
    alert(response.response)
})
// with this
 enPush.register(function(response) {
    alert(response)
})

BMSPushSDK.js

If you are using user ID for registration

// Replace this
bmsPush.registerWithUserId("your UserId", function(response) {
    alert(response.response)
})

// with this
 enPush.registerWithUserId("your UserId", function(response) {
    alert(response)
})

BMSPushSDK.js

Change the unregister API call

// Replace this

bmsPush.unRegisterDevice(function(response) {
    alert(response.response)
   })

// with this

enPush.unRegisterDevice(function (response) {
   alert(response)
})

{: codeblock}

Optionally, if you are using tags:

Change the tag subscriptions as follows:

// Replace this

bmsPush.subscribe("your tag", function (response) {
  alert(response)
})

// with this

enPush.subscribe("your tag", function (response) {
  alert(response)
})

{: codeblock}

Changes to the get all tag subscription for the device

// Replace this
bmsPush.retrieveSubscriptions(function (response) {
  alert(response)
})

// with this

enPush.retrieveSubscriptions(function (response) {
  alert(response)
})

{: codeblock}

Changes to the tag unsubscribe

// Replace this
bmsPush.unSubscribe("your tag", function (response) {
  alert(response)
})

// with this
enPush.unSubscribe("your tag", function (response) {
  alert(response)
})

{: codeblock}

Your web app is ready to work with your new instance of {{site.data.keyword.en_full}}.

Modify the back end

{: #en-migrate-modify-backend} {: step}

This section contains the steps that you perform in the back end. The send notification API is changed and therefore all the SDKs change also.

If you are using the `Node.js` SDK

{: #en-migrate-using-nodejs}

Migrate the existing Node SDK to the new {{site.data.keyword.en_full}} SDK. Follow this link for the new Node Admin SDK documentation.

Changes to importing the SDK

// Replace the following section

var PushNotifications = require('ibm-push-notifications').PushNotifications;
var Notification = require('ibm-push-notifications').Notification;
var PushMessageBuilder = require('ibm-push-notifications').PushMessageBuilder;
var PushNotificationsApiKey = require('ibm-push-notifications').PushNotificationsWithApiKey;

// with this

var IamAuthenticator = require('@ibm-cloud/event-notifications-node-admin-sdk/auth').IamAuthenticator
var EventNotificationsV1 = require('@ibm-cloud/event-notifications-node-admin-sdk/event-notifications/v1')

Changes to initializing the SDK

// Replace the following section

var myPushNotifications = new PushNotificationsApiKey(PushNotifications.Region.US_SOUTH, "appGUID","apikey");

myPushNotifications.getAuthToken(function(hastoken,token){
     console.log(hastoken, token);
}

// with this

const authenticator = new IamAuthenticator({
  apikey: <apikey>,  // Event notifications service instance APIKey
});

const eventNotificationsService = EventNotificationsV1.newInstance({
  authenticator,
  serviceUrl: "https://" + region + ".event-notifications.cloud.ibm.com/event-notifications"
});

Changes to creating notification targets

// Replace the following section

var target = PushMessageBuilder.Target
  .deviceIds(["deviceID1", "deviceID2"])
  .userIds( ["userID1", "userID2"])
  .platforms([Notification.Platform.Apple,
            Notification.Platform.Google,
            Notification.Platform.WebChrome,
            Notification.Platform.WebFirefox,
            Notification.Platform.WebSafari,
            Notification.Platform.AppExtChrome])
  .tagNames(["tag1", "tag2"])
  .build();

// with this

const notificationDevicesModel = {
    user_ids: ['userID1', 'userID2'],
    fcm_devices: ['deviceID1'],
    apns_devices: ['deviceID2'],
    tags: ['tag1', 'tag2'],
    platforms: ['push_android', 'push_ios', 'push_chrome', 'push_firefox', 'push_safari'],
};

Changes to the FCM style payload

// Replace the following section

var style = PushMessageBuilder.FCMStyle
    .type(Notification.FCMStyleTypes
    .BIGTEXT_NOTIFICATION)
    .text("IBM Push")
    .title("Big Text Notification")
    .url(" https://upload.wikimedia.org/wikipedia/commons/2/24/IBM_Cloud_logo.png ")
    .lines(["IBM", "IBM Cloud", "Big Text Notification"])
    .build();

var lights = PushMessageBuilder.FCMLights
    .ledArgb(Notification.FCMLED.RED)
    .ledOffMs(1.0)
    .ledOnMs("1.0")
    .build();

// with this

// Style
const styleModel = {
    type: 'bigtext_notification',
    title: 'Big Text Notification',
    url: ' https://upload.wikimedia.org/wikipedia/commons/2/24/IBM_Cloud_logo.png ',
};

// Lights
const lightsModel = {
    led_argb: 'red',
    led_on_ms: 1.0,
    led_off_ms: '1.0',
};

Changes to FCM message body

// Replace the following section

var fcm = PushMessageBuilder.FCM
   .collapseKey("ping")
   .interactiveCategory("Accept")
   .delayWhileIdle(true)
   .payload({ "alert" : "20% Off for you" })
   .androidTitle("Title for Android")
   .priority(Notification.FCMPriority.DEFAULT)
   .sound("sound.mp3")
   .timeToLive(1.0)
   .icon("http://www.iconsdb.com/icons/preview/purple/message-2-xxl.png")
   .sync(true)
   .visibility(Notification.Visibility.PUBLIC)
   .style(style)
   .lights(lights)
   .build();

// with this

const notificationFcmBodyMessageDataModel = {
  alert: '20% Off for you',
  collapse_key: 'ping',
  interactive_category: 'Accept',
  icon: 'http://www.iconsdb.com/icons/preview/purple/message-2-xxl.png',
  delay_while_idle: true,
  sync: true,
  visibility: 'PUBLIC',
  payload: { "alert" : "20% Off for you" },
  priority: 'DEFAULT',
  sound: 'sound.mp3',
  time_to_live: 1.0,
  lights: lightsModel,
  android_title: 'Title for Android',
  style: styleModel,
  type: 'DEFAULT',
};

// NotificationBodyMessage
const notificationBodyMessageModel = {
  en_data: notificationFcmBodyMessageDataModel,
};

Changes to Send notification method

// Replace the following section

var settings = PushMessageBuilder.Settings
    .fcm(fcm)
    .build();

var notificationExample = Notification.message(message)
    .target(target)
    .settings(settings)
    .build();

myPushNotifications.send(notificationExample, function(error, response, body) {
    console.log("Error: " + error);
    console.log("Response: " + JSON.stringify(response));
    console.log("Body: " + body);
});

// with this

const params = {
  instanceId: instanceId,
  ceIbmenseverity: notificationSeverity,
  ceId: notificationID,
  ceSource: notificationsSource,
  ceIbmensourceid: sourceId,
  ceType: typeValue,
  ceTime: date,
  ceIbmenpushto: JSON.stringify(notificationFcmDevicesModel),
  ceIbmenfcmbody: JSON.stringify(notificationFcmBodyModel),
  ceIbmenapnsbody: JSON.stringify(notificationApnsBodyModel),
  ceIbmenapnsheaders: JSON.stringify(apnsHeaders),
  ceSpecversion: '1.0',
};

let res;
try {
  res = await eventNotificationsService.sendNotifications(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}

If you are using REST API

{: #en-migrate-using-restapi}

This section contains the details about the modifications that are required for Send Notifications API. The new API has extra parameters in the request body. The required parameters for Android push notifications are as follows:

{
   "specversion": "1.0",
   "type": "com.acme.flightbooking.complete"
   "source": "com.acme.flightbooking",
   "id": "1234-1234-sdfs-234",
   "ibmensourceid": "00bb34e5-b8c1-4159-af15-8bc6980c3ab2:api",
   "ibmenfcmbody": "{\"en_data\":{\"alert\":\" Your flight is booked\"}}",
   "ibmenpushto": "{\"fcm_devices\": [\"9c75975a-3898-905d-3bd7c172\"]]}",
  }

For a detailed description of the event attributes, see the {{site.data.keyword.en_full}} event attribute definition.

// Replace this

{
 "message": {
    "alert": "Your flight is booked"
  },
  "target": {
     "tags": ["ibm_tag_1"]
  },
  "settings": {
     "gcm": {
        "interactiveCategory": "view info",
        "androidTitle": "Booking Info",
        "payload": "{\"nid\": \"1234-1234-sdfs-234\"}"
      }
  }
}

// with this
{
  "id": "1234-1234-sdfs-234",
  "ibmenfcmbody": "{\"en_data\":{\"alert\":\"Your flight is booked\",
                    \"android_title\":"Booking Info",
                    \"interactiveCategory\":\"view info\"}}",
  "ibmenpushto": "{\"tags\": [\"ibm_tag_1\"]}",
  "source": "234-rwekj-55bbc6-980c3ab2:scc",
  "ibmensourceid": "91f18cee-7d23-4895-a3ba-0c26696d9d96:api",
  "specversion": "1.0",
  "type": "com.acme.flightbooking.complete"
}

target field is replaced by ibmenpushto
message field is removed. The alert, url fields are part of the ibmenfcmbody
settings->gcm is replaced by ibmenfcmbody

The ibmenpushto fields can take four values same as target of push API

tags –array of tag names
user_ids –array of user ids
fcm_devices –array of device Ids
platforms –the target device platform

The ibmenfcmbody field contains every field in the settings-> gcmfield of service, but with the following changes:

All fields are in snake case instead of camel case. For example, interactiveCategory is interactive_category.
Channels and channel groups {{site.data.keyword.mobilepushshort}}are not supported.

Migrate the data from {{site.data.keyword.mobilepushshort}} service to {{site.data.keyword.en_full}} service

{: #en-migrate-final} {: step}

You can use the push-en-migration-tool to migrate the devices and tag subscriptions data from {{site.data.keyword.mobilepushshort}} service to the {{site.data.keyword.en_full}} service.

Release a new version of the app

{: #en-migrate-release-app} {: step}

After the integration is complete, release the new version of the app. In the new version, ask the user's permission to send a notification and register the device again. In the overlapping window when the user population is migrating from the old version of the app to the new version, the notifications might have to be sent to the existing {{site.data.keyword.mobilepushshort}} environment and the new {{site.data.keyword.en_full}} environment.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

en-migration.md

en-migration.md

Migrating your apps from Push Notifications to {{site.data.keyword.en_short}}

Introduction

Create and configure an instance of the {{site.data.keyword.en_short}} service

Create a source

Create a topic

Create a destination

Create a subscription

Create service credentials

Modify an Android mobile application

Create an Android destination

Modify your project in Firebase console

Edit the Android app

Modify an iOS mobile application

Create an iOS destination

Edit the iOS application

Modify a Web application

Create a Web destination

Chrome Destination

Firefox Destination

Safari Destination

Edit the Web application

Modify the back end

If you are using the `Node.js` SDK

If you are using REST API

Migrate the data from {{site.data.keyword.mobilepushshort}} service to {{site.data.keyword.en_full}} service

Release a new version of the app

Files

en-migration.md

Latest commit

History

en-migration.md

File metadata and controls

Migrating your apps from Push Notifications to {{site.data.keyword.en_short}}

Introduction

Create and configure an instance of the {{site.data.keyword.en_short}} service

Create a source

Create a topic

Create a destination

Create a subscription

Create service credentials

Modify an Android mobile application

Create an Android destination

Modify your project in Firebase console

Edit the Android app

Modify an iOS mobile application

Create an iOS destination

Edit the iOS application

Modify a Web application

Create a Web destination

Chrome Destination

Firefox Destination

Safari Destination

Edit the Web application

Modify the back end

If you are using the Node.js SDK

If you are using REST API

Migrate the data from {{site.data.keyword.mobilepushshort}} service to {{site.data.keyword.en_full}} service

Release a new version of the app

If you are using the `Node.js` SDK