HTML in-app messages support a bridge interface for web apps to interact with the MoEngage SDK. The bridge contains a set of APIs that can be accessed using a global variable moengage. Most APIs work on both Android and iOS. The Platform column in the table below lists the platforms each API is implemented on. Check this column before you use an API in a template that serves both platforms. The below table lists all the JS Bridge methods and in the subsequent sections, each API is explained in detail.

Method Name	Platform	Description
moengage.dismissMessage()	Android, iOS	Attach this method on your template for closing the in-app message
moengage.navigateToScreen(“screen-name”, “optional-data-json”)	Android, iOS	Use this method to navigate the user to a specific screen on click of a template element. Params: “screen-name” : name of the screen for redirection “optional-data-json” : additional key value pairs
moengage.openDeepLink(“deeplink-url”, “optional-data-json”)	Android, iOS	Use this method when you want to open a deeplink from your html in-app template “deeplink-url” : deeplink url “optional-data-json” : additional key value pairs
moengage.openRichLanding(“richlanding-url”, “optional-data-json”)	Android, iOS	Use this method when you want to open a URL inside the app’s webview “richlanding-url” : url that you want to open “optional-data-json” : additional key value pairs
moengage.openWebURL(“web-url”, “optional-data-json”)	Android, iOS	Use this method when you want to open a URL on the app’s default browser “web-url” : url that you want to open “optional-data-json” : additional key value pairs
moengage.copyText(“text-to-copy”, “message”)	Android, iOS	Use this method to copy a coupon code or offer code from your html in-app template to clipboard “text-to-copy”: This text will be copied to clipboard “optional-message”: This message will be shown after copy
moengage.call(“mobile-number”)	Android, iOS	Use this method to initiate a call from your html in-app template “mobile-number”: This number will appear in the dialer
moengage.sms(“mobile-number”, “message”)	Android, iOS	Use this method to initiate an sms from your html in-app template “mobile-number”: SMS will be sent to this “message”: This message will be sent as the SMS
moengage.share(“share-text”)	Android, iOS	Use this method to initiate the share action via any of the available apps on the device.
moengage.customAction(“data-json”)	Android, iOS	Use this method to initiate a custom action defined by your app. “data-json”: key value pairs
moengage.requestNotificationPermission()	Android, iOS	Use this method to request the notification permission from the user.
moengage.navigateToNotificationSettings()	Android, iOS	Use this method to take the user directly to the app’s notification settings screen, without first requesting the permission.
moengage.showPushOptIn()	iOS	Based on the current notification status, either the notification permission prompt is shown or the user is taken to the settings screen where the notification status can be updated.
moengage.navigateToSettings()	iOS	Use this method to navigate to the settings screen of the device. This method is not implemented on Android, where calling it has no effect. To send Android users to their notification settings, use `moengage.navigateToNotificationSettings()` instead.
moengage.trackEvent(eventName, generalAttrJson)	Android, iOS	Use this method to track an event from html in-app template “eventName” : Name of the tracked event “generalAttrJson” : Event attributes that will be tracked along with the event
moengage.trackClick(“widgetId”)	Android, iOS	Use this method to track clicks stats for campaign performance measurement. “widgetId”: This is an optional argument and if passed will help populate the click distribution table. Effective when you have multiple CTAs in a single template
moengage.trackDismiss(widgetId)	Android, iOS	Use this method to track dismiss stats for campaign performance measurement and identifying users who dismiss the in-app message “widgetId”: This is an optional argument and if passed will help populate the click distribution table. Effective when you have multiple dismiss CTAs in a single template
moengage.setEmailId(“value”)	Android, iOS	Use this method to capture the email_id of your users. This will be saved in user profile automatically and can be used to send email campaigns. You can use this with your lead generation / signup forms. “value” : This is the email_id of the user
moengage.setMobileNumber(“value”)	Android, iOS	Use this method to capture the mobile number of your users. This will be saved in user profile automatically and can be used to send SMS campaigns. You can use this method with your lead generation / signup forms. “value” : This is the mobile number of the user
moengage.setUserName(“value”)	Android, iOS	Use this method to capture the Name of your users. This will be saved in user profile automatically. You can use this method with your lead generation / signup forms. “value” : This is the username of the user
moengage.setFirstName(“value”)	Android, iOS	Use this method to capture the First Name of your users. This will be saved in user profile automatically. You can use this method with your lead generation / signup forms. “value” : This is the first name of the user
moengage.setLastName(“value”)	Android, iOS	Use this method to capture the Last Name of your users. This will be saved in user profile automatically. You can use this method with your lead generation / signup forms. “value” : This is the last name of the user
moengage.identifyUser(“value”)	Android, iOS	Use this method to identify the user against a unique identifier configured in your workspace. “value” : This is the unique identifier of the user
moengage.setUniqueId()	Android, iOS	Use this method to set the Client ID of your users. Pass the user’s Client ID.
moengage.setAlias()	Android, iOS	Use this method to update the existing Client ID of your users. Pass the new Client ID.
moengage.setGender()	Android, iOS	Use this method to set the Gender of your users. Accepted values are “male”, “female”, and “other”.
moengage.setBirthDate()	Android, iOS	Use this method to set the Birthdate of your users. Pass the date of birth in ISO 8601 format.
moengage.setUserLocation(lat, lng)	Android, iOS	Use this method to set the Location (lat,lng) of your users. lat : Latitude of the user lng : Longitude of the user
moengage.setUserAttribute(name,value)	Android, iOS	Use this method to set custom attributes of your users when data type of the attribute is string, numeric or boolean. name : Name of the user attribute to be tracked value : Value of the tracked user attribute.
moengage.setUserAttributeDate(name,value)	Android, iOS	Use this method to set custom attributes of your users when data type of the attribute is date name : Name of the user attribute to be tracked value : Value of the tracked user attribute in ISO 8601 format
moengage.setUserAttributeLocation(name,lat,lng)	Android, iOS	Use this method to set custom attributes of your users when data type of the attribute is location name : Name of the user attribute to be tracked lat,lng : Location of the user
moengage.trackRating()	Android, iOS	Use this method to capture the rating of your users from a rating template. Pass the rating value submitted by the user.

The subsequent sections provide more details on how to use each API. The provided JS Methods are classified into two categories - JS Methods for Actions and JS Methods for Data Tracking

Actions

The following sections will provide more details on the JS Methods for actions.

JS Methods for ActionsIntegrate the JS Methods for Actions with your HTML Template to execute on-click actions like message close, navigation actions like re-direction to screens or webpages, or any other actions as supported with in-app campaigns.

Dismiss In-App Message

To dismiss in-app messages use moengage.dismissMessage() API.

moengage.dismissMessage();

Do not use other API when the moengage.dismissMessage()API is in use.

Navigate to Screen

You can open a screen using moengage.navigateToScreen(<screen-name>, <optional-data-json>).

var screenName = "com.moengage.sampleapp.ui.activity.MainActivity";
// Optionally add data json object
var attributes = {
  "nav_screen_attr1": "val1",
  "nav_screen_attr2": 100,
  "nav_screen_attr3": 123.11,
  "nav_screen_attr4": true
};
    
moengage.navigateToScreen(value, attributes);

Open Deeplink URL

To open a deeplink URL use moengage.openDeepLink(<deeplink-url>, <optional-data-json>).

var value = "moengage://testdeeplink/testActivity";
// Optionally add data json object
var attributes = {
  "nav_screen_attr1": "val1",
  "nav_screen_attr2": 100,
  "nav_screen_attr3": 123.11,
  "nav_screen_attr4": true
};
moengage.openDeepLink(value, attributes);

Open Richlanding Screen

To open a Richlanding screen use moengage.openRichLanding(<richlanding-url>, <data-json>).

var value = "https://www.google.com";
// Optionally add data json object
var attributes = {
  "nav_screen_attr1": "val1",
  "nav_screen_attr2": 100,
  "nav_screen_attr3": 123.11,
  "nav_screen_attr4": true
};
moengage.openRichLanding(value, attributes);

Open Web URL

To open a URL in a web browser use moengage.openWebURL(<web-url>, <optional-data-json>).

var value = "https://www.google.com";
// Optionally add data json object
var attributes = {
  "nav_screen_attr1": "val1",
  "nav_screen_attr2": 100,
  "nav_screen_attr3": 123.11,
  "nav_screen_attr4": true
};
    
moengage.openWebURL(value, attributes);

Copy Text to Clipboard

To copy text to clipboard use moengage.copyText(<text-to-copy>, <message>) API.

moengage.copyText("COUPON100", "Rs.100 OFF!");

Call

To perform call action use moengage.call(<mobile-number> API.

moengage.call("1234567890");

SMS

To send an SMS use moengage.sms(<mobile-number>, <message>) API.

moengage.sms("1234567890", "Hi There!");

To share a string content use moengage.share(<share-text>) API.

moengage.share("Content to share");

Custom Action

To perform custom action set the data using moengage.customAction(<data-json>) API.

var attributes = {
  "attr1": "val1",
  "attr2": 100,
  "attr3": 123.11,
  "attr4": {
    "int": 30
  }
};
moengage.customAction(attributes);

Push Notification Permission

Use these methods to prompt users to enable push notifications, or to send them to the notification settings screen when they have already disabled notifications.

Request the Notification Permission

To request the notification permission, use the moengage.requestNotificationPermission() API. This method works on both Android and iOS, so you can use it in a single template that serves both platforms.

moengage.requestNotificationPermission();

On Android, the system permission dialog is shown while the permission can still be requested. After the user denies the permission twice, Android stops showing the dialog, and the user is taken to the settings screen instead.

Navigate to Notification Settings

To take the user directly to the app’s notification settings screen without first requesting the permission, use the moengage.navigateToNotificationSettings() API. This method works on both Android and iOS. Use this when push is already disabled for your app and a permission prompt would not be shown — for example, an in-app message that tells users notifications are off and gives them a CTA to turn them back on.

moengage.navigateToNotificationSettings();

To handle notification permission from your app code instead of an in-app message, see Notification Runtime Permissions.

Show the Push Opt-In Prompt

To prompt for the notification permission on iOS, use the moengage.showPushOptIn() API. Based on the current notification status, the SDK either shows the notification permission prompt or takes the user to the settings screen where the notification status can be updated.

moengage.showPushOptIn();

moengage.showPushOptIn() is implemented on iOS only. If your template also serves Android, use moengage.requestNotificationPermission() instead, which works on both platforms.

Navigate to Device Settings

To open the device settings screen, use the moengage.navigateToSettings() API.

moengage.navigateToSettings();

moengage.navigateToSettings() is implemented on iOS only. On Android, the method exists on the bridge but does nothing, so a CTA that calls it appears unresponsive to Android users. To send Android users to their notification settings, use moengage.navigateToNotificationSettings() instead.

Data Tracking

The following sections will provide more details on the JS Methods for data tracking.

JS Methods for Data TrackingYou would need to integrate the JS Methods for Data Tracking in your template for the following use-cases:

Tracking stats (clicks, close)
Tracking events (for surveys, rating, lead gen)
Tracking user attributes (for lead gen, signup etc.)

Track Event

To track an event use

moengage.trackEvent(eventName, generalAttrJson, locationAttrJson, dateAttrJson, isNonInteractive, shouldAttachCampaignMeta)

API. The trackEvent() takes in up to six parameters.

eventName : String
generalAttrJson : JSON Object for general attributes. Accepted data types are string, float, boolean, int, JSON objects.

{
  " <attribute_name >": " <attribute_value >",
  " <attribute_name >": " <attribute_value >",
  ...  
}

locationAttrJson : JSON Object for location attributes. Accepts attribute name and latitude and longitude

{
  " <attribute_name >": {
    "latitude":  <latitude >,
    "longitude":  <longitude >
  },
  " <attribute_name >": {
    "latitude":  <latitude >,
    "longitude":  <longitude >
  },
  ...
}

dateAttrJson : JSON Object for date-time attributes. Accepts only ISO-8601 format dates

{
  " <attribute_name >": "yyyy-MM-dd'T'HH:mm:ss.fff'Z'",
  " <attribute_name >": "yyyy-MM-dd'T'HH:mm:ss.fff'Z'",
  ...
}

isNonInteractive: true if you want the event to be non-interactive, else false.
shouldAttachCampaignMeta: true if you want to attach campaign metadata to the event, else false.

Apart from the eventName parameter, other parameters are non-mandatory you can pass {}.
It is important to maintain the order in which parameters are passed, i.e. if you want to pass only the location attributes general attribute should be passed {}.For general cases, you would just be passing the event-name and event-attributes JSON and in this case you can skip the other params.

The following example shows all six parameters in order, and how to pass {} for the attribute types you skip.

// All six parameters
moengage.trackEvent(
  "Order_Placed",
  {
    "product_name": "Running Shoes",
    "quantity": 2,
    "amount": 4599.00,
    "is_gift": false
  },
  {
    "store_location": {
      "latitude": 12.9716,
      "longitude": 77.5946
    }
  },
  {
    "delivery_date": "2026-09-15T10:30:00.000Z"
  },
  false,
  true
);

// Event name and general attributes only
moengage.trackEvent("Response_Submitted", {
  "response1": "[email protected]",
  "response2": "approved"
});

// Location attributes only - pass {} for the general attributes you skip
moengage.trackEvent("Store_Located", {}, {
  "store_location": {
    "latitude": 12.9716,
    "longitude": 77.5946
  }
});

Track Click Event

To track widget click events use moengage.trackClick(widgetId) API. The <widgetId> can be int or string, otherwise, the click event will not be tracked.

//track click event
moengage.trackClick("image_1");
moengage.trackClick(10);

Track Dismiss

To track in-app dismissal events, use moengage.trackDismiss(widgetId) API. The <widgetId> can be int or string. If not passed, the event is tracked without a <widgetId>.

moengage.trackDismiss("dismiss_btn_1");
moengage.trackDismiss(1);

Deprecated: trackDismiss() Without a Widget ID

Calling moengage.trackDismiss() with no argument is deprecated. The dismissal is still tracked, but without a <widgetId> the click distribution table is not populated. Pass a <widgetId> as shown above instead.

moengage.trackDismiss();

Identify User

To identify the user against a unique identifier configured in your workspace, use the moengage.identifyUser(<value>) API. Use this from lead generation, sign-up, or login templates to attribute the session to a known user.

moengage.identifyUser("unique-id");

Configure your identifiers in MoEngage before you call this method. For details on how identifiers are resolved into a single user profile, see Unified Identity and Identity Resolution.

Track Default User Attributes

The following JavaScript methods are available for tracking default user attributes.

API name	API Description
moengage.identifyUser()	Identify the user against a unique identifier configured in your workspace
moengage.setAlias()	Update user’s unique id which was previously set by `moengage.setUniqueId()`
moengage.setUniqueId()	Set user UniqueId
moengage.setUserName()	Set user name
moengage.setFirstName()	Set user first name
moengage.setLastName()	Set user last name
moengage.setEmailId()	Set user email-id
moengage.setMobileNumber()	Set user mobile number
moengage.setGender()	Set user gender (“male”/“female”/“other”)
moengage.setBirthDate()	Set user birthday. The value must be an ISO-8601 format date.
moengage.setUserLocation()	Set user location
moengage.trackRating()	Track user input action rating

Example:

// Identify the user
moengage.identifyUser("unique-id");
// Set the Client ID
moengage.setUniqueId("unique-id");
// Update a Client ID that was set earlier
moengage.setAlias("new-unique-id");
// Set the user's name
moengage.setUserName("Jane Doe");
moengage.setFirstName("Jane");
moengage.setLastName("Doe");
// Set the user's contact details
moengage.setEmailId("[email protected]");
moengage.setMobileNumber("1234567890");
// Set the gender - accepted values are "male", "female", and "other"
moengage.setGender("female");
// Set the date of birth in ISO-8601 format
moengage.setBirthDate("2017-08-02T06:05:30.000Z");
// Set the user's location as latitude, longitude
moengage.setUserLocation(12.9716, 77.5946);
// Track a rating submitted from a rating template
moengage.trackRating(4.5);

Track Custom User Attributes

The following JavaScript methods are available for tracking custom user attributes.

API name	API description
moengage.setUserAttribute()	Set custom user attribute
moengage.setUserAttributeDate()	Set custom user date
moengage.setUserAttributeLocation()	Set custom user location

Example:

// Set string, numeric, and boolean attributes
moengage.setUserAttribute("loyalty_tier", "gold");
moengage.setUserAttribute("orders_placed", 12);
moengage.setUserAttribute("wallet_balance", 250.75);
moengage.setUserAttribute("newsletter_opted_in", true);

// Set a date attribute in ISO-8601 format
moengage.setUserAttributeDate("last_purchase_date", "2017-08-02T06:05:30.000Z");

// Set a location attribute as latitude, longitude
moengage.setUserAttributeLocation("preferred_store", 12.9716, 77.5946);

SDKs

JavaScript Bridge for HTML In-Apps

Actions

Dismiss In-App Message

Navigation Actions

Navigate to Screen

Open Deeplink URL

Open Richlanding Screen

Open Web URL

Copy Text to Clipboard

Call

SMS

Custom Action

Push Notification Permission

Request the Notification Permission

Navigate to Notification Settings

Show the Push Opt-In Prompt

Navigate to Device Settings

Data Tracking

Track Event

Track Click Event

Track Dismiss

Identify User

Track Default User Attributes

Track Custom User Attributes

​Actions

​Dismiss In-App Message

​Navigation Actions

​Navigate to Screen

​Open Deeplink URL

​Open Richlanding Screen

​Open Web URL

​Copy Text to Clipboard

​Call

​SMS

​Share

​Custom Action

​Push Notification Permission

​Request the Notification Permission

​Navigate to Notification Settings

​Show the Push Opt-In Prompt

​Navigate to Device Settings

​Data Tracking

​Track Event

​Track Click Event

​Track Dismiss

​Identify User

​Track Default User Attributes

​Track Custom User Attributes

Actions

Dismiss In-App Message

Navigation Actions

Navigate to Screen

Open Deeplink URL

Open Richlanding Screen

Open Web URL

Copy Text to Clipboard

Call

SMS

Share

Custom Action

Push Notification Permission

Request the Notification Permission

Navigate to Notification Settings

Show the Push Opt-In Prompt

Navigate to Device Settings

Data Tracking

Track Event

Track Click Event

Track Dismiss

Identify User

Track Default User Attributes

Track Custom User Attributes