1. In the Background color, select the message background color.
2. In-App name color(Android only), select the color of the app’s name.
3. In the Notification control color(Android only), click Light or Dark to control the notification’s color.
4. Turn on the Apply background color in text editor toggle to apply the chosen background color to the text editor fields -Title, Message, and Summary. This should help you with visibility when using the lighter-colored font.
5. Follow the steps described in Common push template elements.
6. Make sure to check the preview in both light and dark modes to ensure that the notification looks good and is readable in both modes.
7. In Image section, for iOS:
   • Select Image/GIF URL and type or paste the URL of the image/GIF.
   • Click Upload Image/GIF and drag and drop the image/GIF or click the upload from the computer the stored image/GIF. The recommended size is 25 KB to 200 KB, and for GIFs, it is up to 500 KB. For more information, refer here.

1. Follow the steps described in Common Push template elements.
2. Enable Auto Dismiss Notification by turning on the Auto-dismiss notification toggle. You can select the time duration after which the notification will automatically be removed from the user’s notification tray after the push notification is delivered to the user. The time duration can be chosen in minutes, hours, and days. The maximum value allowed is 1 day. This is only applicable to Android devices. \
   If the Auto Dismiss duration has already passed before the notification is delivered, Notification Received events will not be tracked. In such cases, the notification is not displayed to the user.

• Android
• iOS

ExpandedCollapsed

ExpandedCollapsed

• The image slide show can be set to auto-play oron-demand.
• The images can be personalized.

1. Follow the steps described in the Stylised Basic Notification.
2. In Simple Carousel Content, do the following:

   Field	Description
   Slider transition	Click Manual to make the transition between images by clicking on the image. OR Click Automatic to make the transition between images automatically. Only supported up to Android 10. For Android 11 and higher, slider transition will always be manual irrespective of the option selected
   Image	Do one of the following: Click Image URL and type or paste the URL of the image. Click Upload Image and drag and drop the image or click the upload from the computer the stored image. Image Scaling Options: Select Crop image to see a center-cropped image on the device and in the preview. Select Fit to container to center the image inside the container. Note: Image Scaling is available only for Android 12 and above.
   Image click action	From the drop-down, select one of the following: Navigate to screen: From the Take user to a specific screen drop-down, select the screen to which the user needs to navigate. Deeplinking :Type or paste the URL to which the user needs to navigate to. Rich landing: Type or paste the Rich landing page to which the user needs to navigate to.
   Default click action	From the drop-down, select one of the following: Navigate to screen : From the Take user to a specific screen drop-down, select the screen to which the user needs to navigate. Deeplinking: Type or paste the URL to which the user needs to navigate to. Rich landing: Type or paste the Rich landing page to which the user needs to navigate to.
   KV Pair	Follow these steps to create a Simple Image banner and Text overlay on the image push template: Click New KV Pair In Key value pairs, enter the key and value.

3. Click Advanced and follow the described steps in Advanced.
4. Click Template backup and follow the described steps in Template Backup.

• Android
• iOS

ExpandedCollapsed

ExpandedCollapsed

1. In step 2 of Push campaign creation, select template type as Image banner with text overlay notification.
2. Fill in the following fields described in the Common push template elements section:
3. Notification Channel
4. Message
5. Title Message
6. Default Click Action
7. Turn on the Include App name and time toggle to include the app name and time in the notification.
8. Select the color name for the App name using App name color. You can also choose the ‘system default’ for the App name color.
9. Select either the ‘Light’ or ‘Dark’ mode in the Notification controls color toggle.
10. To add a banner image to the notification, do the following:
11. Click on the ‘Image URL’ option to type or paste the URL of the image.
12. The image URL can also be personalized by typing ’@’ in the field. This will invoke the personalization UI and
13. Click on the ‘Upload Image’ option to drag and drop the image or click the upload from the computer to upload a stored image. The recommended image size is around 25 KB, and the recommended aspect ratio is 2:1 (width: height).
14. Collapsed Push Notification: Select one of the following to choose the image to be displayed when the push notification is collapsed.
15. Keep same as template backup: In the collapsed mode, the text would remain the same as the template backup’s message. Only the text would be shown here, and the image wouldn’t be shown.
16. Show collapsed image: This option allows you to add a separate image to be displayed when the notification is collapsed. When this option is chosen, you can also scale the image.
    • Image Scaling Options: Select Crop image to see a center-cropped image on the device and in the preview. Select Fit to container to center the image inside the container. Note: Image Scaling is available only for Android 12 and above.

• Expanded
• Collapsed

1. In step 2 of Push campaign creation, select template type as Timer.
2. Add information to the fields present in the Basic details, buttons, and advanced as mentioned in the common push template elements section above.
3. In the Timer section, you can configure how long the notification will be displayed on the user’s device. For example, if the duration is set as 4 hours in the timer section, the notification will be displayed for four hours from when the notification gets sent successfully to the user’s device. At the end of four hours, the notification will be dismissed automatically.
4. Select the timer duration using the ‘Timer ends at’ field.

5. Select the Timer Text Colorusing the ‘Select color’ option, as shown below. There is the option to choose the ‘System default’, too, if you do not wish to customize the color for the timers.

• Expanded
• Collapsed

​

Create a Background Update Notification

In Step 2 of your push campaign creation, select the Background Update tile.

1. The primary input for this template is a Key-Value (KV) Pair interface. These pairs are sent at the root level of the push payload. The backend handles value serialization differently depending on the target OS:
   • Android: To comply with FCM Data Message standards, the backend stringifies all values (numbers, booleans, and objects).
   • iOS: Valid JSON strings entered in the value field are sent as proper JSON objects. Non-valid JSON is sent as a string.
2. Unlike standard push notifications, the Background Update template is designed to be silent. The delivery mechanism adapts to each operating system’s background processing requirements:
   • On Android: The payload is delivered as a high-priority Data Message. The MoEngage SDK intercepts this and passes the raw data to your app without showing a notification in the tray.
   • On iOS: MoEngage uses the content-available flag to wake your app in the background for up to 30 seconds. This allows your app to refresh content or sync data without alerting the user.
     In both cases, your developers must implement a specific SDK callback to “listen” for these payloads and trigger the desired app logic.

In Step 3 of your push campaign creation, a new targeting option, Background Update Targeting is available in the Advanced section. This option appears only if the Background Update template is selected for all platforms, locales, and variants. For more information, refer to Create Push Campaigns.

​

Analytics and Info

• Metrics such as Sent and Delivered are tracked normally.
• Because there is no system UI, Impressions and Clicks are not automatically recorded.
• If the background update triggers a custom local notification or a UI change, developers must manually call the trackPushClick SDK method to attribute those interactions to the campaign.

• All configured keys and values are displayed in a read-only format.
• If a value was entered as a valid JSON object, it will be displayed as a formatted JSON block for easier readability.
• Use the preview panel to visualize the final JSON structure as it appears to the device, including system-injected tracking keys.

1. String Value
   key1: User1
   
2. Valid JSON Object JSON
   key2: {
   "k1": "v1"(string),
   "k2": true/false(boolean),
   "k3": 200(number)
   }
   
3. Non-Valid JSON JSON
   key2: {
   "k1": User,
   "k2": True,
   "k3": 200
   
   • iOS Output JSON
     {
     "Key1ios": 200,
     "k2ios": true,
     "k3ios": "Praxxxn",
     "k4ios": "{\\n\\"k1\\": User,\\n\\"k2\\": True,\\n\\"k3\\": 200"
     }
     
     • Ensure your input is a valid JSON, because the backend treats invalid JSON inputs as malformed strings. If your input is not a valid JSON, your integration must include the logic to handle non-structured string data.
     • In the above output, the non-valid JSON is treated as a malformed string: "k4ios": "{\\n\\"k1\\": User,\\n\\"k2\\": True,\\n\\"k3\\": 200"
   • Android Output JSON
     {
     "message": {
     "data": {
     "Key1Android": "200",
     "k2android": "true",
     "k3android": "Praxxxn",
     "k4android": "{\n\"k1\": User,\n\"k2\": True/False,\n\"k3\": 200"
     }
     }
     

• Timer with Progress Bar template
  The SDK uses Alarms to periodically update the progress in the progress bar. Starting Android 14, the Alarm permission is off by default. So you need to ask for explicit Alarm permission if you want to show Timer notifications apart from adding a line in your manifest file. For more information, refer to Push Templates.
  If the application does not have the permission above, the Timer with Progress Bar template will not be shown to the user; instead, a backup template will be displayed to the user which will have the Timer but not the progress bar.
• Sticky notifications
  On a device with Android 14 or higher, the user can dismiss sticky notifications by the swipe action. The notification will remain in the tray if the user performs the Clear all notification action (which helps with accidental dismissals) and the notifications are still dismissible when the phone is locked. Refer to Android 14 documentation here.

1. All the backups in all variants are empty.
2. All the mandatory fields are filled.
3. The backup is not filled.

1. Errors start displaying only after you try to switch between the pages or try to do a test notification
2. Error is also displayed in the slide when you open the slide’s tab.

1. Error for the carousel slide is displayed in the toaster along with the name of the slide that has the error.
2. The sliding tab which has an error will not be automatically opened at the moment. (Some tech challenges in that implementation).

• Both Template and Backup have an inline fallback for Personalization
• While adding the personalization attribute, you can select the ‘replace text’ option to add an inline Fallback
• To add the fallback, use the following Jinja template:

​

Sample personalization with Fallback:

• Example: first name user attribute
• Template message: ‘Hi John, Welcome to MoEngage. To proceed further, click here.’
• Fallback message: ‘Good Morning. To proceed further, click here.’

{% set firstName = {{UserAttribute['First Name']}} %}
{% if firstName %}Hi {{ firstName }}, Welcome to MoEngage
{% else %}Good Morning
To proceed further, click here
{% endif %}

​

Ideal Aspect Ratio for Images

​

For Android

1. When your creatives should not be cropped Create your Push Notification by following the aspect ratio specified for Device Type A with the most common screen size. Use the Fit inside image container in the Image scaling section during template creation to ensure that your creative is not cropped. You may see white spaces horizontally or vertically.
2. When your creative does not have meaningful content in the extremities (10% margin from each side) Use the Fill image container option in the Image scaling section during template creation and add a margin to your image. This will ensure that even in extreme cases, your meaningful content will never be cropped, even if you see some margin cropping.