|
Early Access This is an Early Access feature. To enable it for your account, contact your CSM or raise a support ticket. |
Overview
Marketers who send push notifications containing sensitive information want to ensure the intended recipient receives the notification on their latest active device. This is not a concern for Email, SMS, and WhatsApp notifications because they are sent to the email ID and mobile number, which are unique to individual users. Also, mobile numbers and email IDs are generally not shared among users. However, push notifications sent at a device level can create issues as devices can be shared among users, potentially exposing sensitive notifications.
The Primary Device Per User feature allows you to send push notifications only to the user's last active device, thereby maintaining privacy while receiving sensitive notifications. However, targeting a single or primary device per user retains all devices associated with a user without deleting them, but campaigns are sent exclusively to the last active device.
Detect the Primary Device
To detect the primary device, MoEngage maintains an additional flag for all devices at the user level. This flag marks the latest active device as the primary device.
When a user is associated with multiple devices, MoEngage tracks the event time using the SDK, which is when the user executes the event. Based on the latest event time captured by MoEngage, the device with the latest event time is marked as the primary device by setting a Primary flag. Note that only one device can have the primary flag, while the rest cannot.
For instance, user U1 has three devices: D1, D2, and D3. Based on the SDK request, if the event time of D2 is greater than the latest event time of the other devices, D2 is marked as the primary device for user U1.
| info |
Information
|
Send Campaigns to the Last Active Device
You can send campaigns to the last active device in the following ways:
Using the MoEngage Dashboard
The feature of targeting the last active device applies to the following campaign types within MoEngage:
Push Campaigns
Perform the following to access this feature while creating the push campaigns:
- Navigate to Step 3: Schedule and Goals.
- In the Advanced section, select the Last Active device check box to send this push campaign only to the latest active device of the target user.
Flows Campaigns with the Push Stage
Perform the following to access this feature while creating the Flows campaign with the push stage:
- Navigate to Step 3: Who will enter the flow, add the required details, and click Next.
- On the canvas, click the plus icon to Add stage > In Actions > Push.
- On the Push campaign page, add the required details and navigate to the Advanced section.
- You can select the Last Active device check box to send this flow campaign only to latest active device of the target user.
Alerts Configured with the Push Channel
Perform the following to access this feature while creating the alerts campaign with the push channel:
- Navigate to Step 2: Content.
- Type the required details for your push channel and navigate to the Advanced Settings section.
- You can select the Last Active device checkbox to send this alert only to the latest active device of the target user.
Using APIs
You can use the following APIs to sent campaigns to the last active device of the user:
Using the Push API
The Push API allows you to create a push campaign, and if you want this campaign to be sent to the last active device of the user, pass a parameter targetLastActiveDevice=true. Following is the sample cURL request for the same:
curl --location 'https://pushapi-0X.moengage.com/v2/transaction/sendpush
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'MOE-APPKEY: {{Workspace_ID or APP_ID}}' \
--header 'Authorization: Basic {{Authorization_Key}}' \
--data '{
"signature": "{{signature}}",
"requestType": "push",
"responseId": "{{repsonseId}}",
"appId": "{{appId}}",
"campaignName": "Sample Campaign",
"targetAudience": "All Users",
"targetPlatform": [
"ANDROID",
"IOS"
],
"payload": {
"ANDROID": {
"message": "Sample Message",
"title": "Sample Title",
"Summary": "Sample Summary",
"richContent": [
{
"type": "image",
"value": "https://www.planwallpaper.com/static/images/desktop-year-of-the-tiger-images-wallpaper.jpg"
},
{
"type": "coupon",
"value": "free"
},
{
"type": "sound",
"value": "tring"
}
],
"defaultAction": {
"type": "navigation",
"value": "com.moengage.demoapp.SecondActivity"
},
"additionalActions": [
{
"type": "call",
"value": "12345678",
"name": "Call button",
"iconURL": "abc"
},
{
"type": "copy",
"value": "12345678",
"name": "Copy button",
"iconURL": "abc"
}
],
"fallback": {
"message": "Sample Message",
"title": "Sample Title",
"richContent": [
{
"type": "image",
"value": "https://picsum.photos/200/300/?random"
},
{
"type": "coupon",
"value": "free"
},
{
"type": "sound",
"value": "tring"
}
],
"defaultAction": {
"type": "richlanding",
"value": "https://www.google.co.in/webhp?sourceid=chrome-instant&ion=1&espv=2&ie=UTF-8"
},
"additionalActions": [
{
"type": "call",
"value": "12345678",
"name": "Call button",
"iconURL": "abc"
},
{
"type": "copy",
"value": "12345678",
"name": "Copy button",
"iconURL": "abc"
}
]
}
},
"IOS": {
"message": "Sample Message",
"title": "Sample Title",
"contentAvailable": 1,
"richContent": [
{
"type": "sound",
"value": "custSound2.wav"
},
{
"type": "image",
"value": "https://picsum.photos/200/300/?random"
},
{
"type": "coupon",
"value": "This is an automated API message:51"
}
],
"additionalActions": [
{
"category": "abc"
}
],
"defaultAction": {
"type": "navigation",
"value": "",
"kvPairs" :{
"key1" : "value1",
"Key2" : "value2"
}
},
"fallback": {
"message": "Sample Message",
"title": "Sample Title",
"richContent": [
{
"type": "coupon",
"value": "iOS"
}
],
"additionalActions": [
{
"category": "abc"
}
]
}
},
"WINDOWS": {
"message": "Sample Message",
"title": "Sample Title",
"richContent": [
{
"type": "coupon",
"value": "ANDROIDCOUPEN"
}
],
"fallback": {
"message": "Sample Message",
"title": "Sample Title",
"richContent": [
{
"type": "coupon",
"value": "ANDROIDCOUPEN"
}
]
}
}
},
"campaignDelivery": {
"type": "soon"
},
"advancedSettings": {
"ttl": {
"ANDROID": 12,
"WEB": 24
},
"ignoreFC": "true",
"targetLastActiveDevice": "true",
"notificationPrioritySettings": {
"ANDROID": "normal",
"IOS": 5
}
}
}'
For more information on Push API, refer to Push API.
Using the Inform API
The Inform API allows you to send push notifications specifically to a user's most recently active device. Note that this functionality is limited to triggering notifications for alerts that have been pre-configured within the MoEngage dashboard. You cannot use the Inform API to create or send new alerts that have not already been set up on the MoEngage dashboard.
For more information on Inform API, refer to Inform API.
Use Case 1: cURL Request Containing a Push-Token Parameter
The following cURL request contains a push token parameter and is sent to trigger push notifications for alerts that have been previously created. Push notifications are only delivered if the cURL request contains the push token of the last active device of the user.
For example, consider a scenario where a user has three devices: D1, D2, and D3, with D3 being the last active. When configuring the alerts in the MoEngage dashboard,you send the alert to the last active device. If the cURL request includes the push token parameter of the last active device (D3), the push notification is delivered to the user whose User ID is mentioned in the request. However, if the API request contains the push token for D1 or D2, the push notification is not delivered.
curl --location --request POST 'https://inform-api-0X.moengage.com/v1/send' \
--header 'MOE-APPKEY: YOUR_APP_KEY_HERE' \
--header 'Authorization: Basic Base64_ENCODED_APPKEY_APIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
"recipient":"<push-token>"
}
}
}'
Use Case 2: cURL Request Without a Push-Token Parameter
The following cURL request does not contain a push token parameter and is sent to trigger push notifications for alerts that have been previously created. The push notifications are delivered to the last active device of the user.
For example, consider a scenario where a user has three devices: D1, D2, and D3, with D3 being the last active. When configuring the alerts in the MoEngage dashboard, you send the alert to the last active device (D3). As the cURL request does not contain any push token, the push notification is delivered to the last active device of the user whose User ID is mentioned in the request.
curl --location --request POST 'https://inform-api-0X.moengage.com/v1/send' \
--header 'MOE-APPKEY: YOUR_APP_KEY_HERE' \
--header 'Authorization: Basic Base64_ENCODED_APPKEY_APIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"alert_id": "636b77e6e2cf83277195fb60",
"alert_reference_name": "Demo_ID",
"user_id": "USER_ID",
"transaction_id": "YOUR_TRANSACTION_ID_VAL_HERE",
"payloads": {
"PUSH": {
}
}
}'
| info |
Information
|