Skip to main content

​
Configuring Push Callbacks

MoEngage Plugin provides listeners for push events. These events are a common trigger for both iOS and Android platforms. Refer to the below code to set the listener to the same:
Make sure you are calling initialize() method of the plugin to receive these callbacks. Refer Initialise Capacitor Component for more info.

​
Push Token Generated Observer

Add a listener to listen to the pushTokenGenerated as shown below. 
import { MoECapacitorCore, MoEPushTokenData } from 'capacitor-moengage-core'
MoECapacitorCore.addListener("pushTokenGenerated", (data: MoEPushTokenData) => {
 console.log(" Received callback 'pushTokenGenerated',  data: " + JSON.stringify(data))
});

​
Notification Click Observers

Add a listener to listen to the pushClicked as shown below. 
import { MoECapacitorCore, MoEPushCampaignData } from 'capacitor-moengage-core'
MoECapacitorCore.addListener("pushClicked", (data: MoEPushCampaignData) => {
 console.log(" Received callback 'pushClicked',  data: " + JSON.stringify(data))
});

​
Payload

PushToken received in the callback is a MoEPushTokenData instance with the following definition: 
/**
 * Push token object
 */
 export interface MoEPushTokenData {
    /**
     * Platform type
     */
    platform: MoEPlatform;
    /**
     * Type of push service
     */
    pushService: MoEPushService;
    /**
     * Push Token
     */
    token: String;
}
export declare enum MoEPlatform {
    iOS = "iOS",
    ANDROID = "android"
}

export declare enum MoEPushService {
    APNS = 0,
    FCM = 1,
    MI_PUSH = 2,
    PUSH_KIT = 3
}
NotificationPayload received in the callback is a MoEPushCampaignData instance with the following definition: 
/**
 * Push event data
 */
export interface MoEPushCampaignData {
    /**
     * Account information
     */
    accountMeta: MoEAccountMeta;
    /**
     * Push campaign object
     */
    pushCampaign: MoEPushCampaign;
    /**
     * Platform data
     */
    platform: MoEPlatform;
}

/**
* Account Object
*/
export interface MoEAccountMeta {
    /**
     * Account identifier
     */
    appId: string;
}
      
export interface MoEPushCampaign {
    /**
     * Is the click action a defualt action
     */
    isDefaultAction: boolean;
    /**
     * Clicked Action data
     */
    clickedAction: Map<String, object>;
    /**
     * Key-Value Pair entered on the MoEngage Platform during campaign creation.
     */
    payload: Map<String, object>;
}

export declare enum MoEPlatform {
    iOS = "iOS",
    ANDROID = "android"
}
Payload Structure for clickedAction Map 
{
  "clickedAction": {
    "type": "navigation/customAction",
    "payload": {
      "type": "screenName/deepLink/richLanding",
      "value": "",
      "kvPair": {
        "key1": "value1",
        "key2": "value2",
        ...
      }
    }
  }
}
platform - Native platform from which callback is triggered. Possible values - android, ios
isDefaultAction - This key is present only for the Android Platform. It’s a boolean value indicating if the user clicked on the default content or not. true if the user clicks on the default content else false.
clickedAction - Action to be performed on notification click.
clickedAction.type - Type of click action. Possible values navigation and customAction. Currently, customAction is supported only on Android.
clickAction.payload - Action payload for the clicked action.
clickedAction.payload.type - Type of navigation action defined. Possible values screenName, deepLink, richLanding. Currently, in the case of iOS, richlanding and deep-link URLs are processed internally by the SDK and not passed in this callback therefore possible value in the case of iOS is only screenName.
clickAction.value - value entered for navigation action or custom payload.
clickAction.kvPair - Custom key-value pair entered on the MoEngage Platform.
payload - Complete campaign payload.

​
Android Payload

If the user clicks on the default content of the notification the key-value pair and campaign payload can be found inside the payload key. If the user clicks on the action button or a push template action the action payload would be found inside clickedAction.
You can use the isDefaultAction key to check whether the user clicked on the default content or not and then parse the payload accordingly.

​
iOS Payload

In the case of iOS, you would always receive the key-value pairs with respect to clicked action in clickedAction property. Refer to this [/developer-guide/ios-sdk/push/advanced/custom-notification-handling#notification-payload] for knowing the iOS notification payload structure.