In-App Message

The in-app message is an on-site channel that displays content to users when they access an app or website. It can be used for various purposes, such as directing customers to a specific page or encouraging them to take a particular action.

The in-app message feature is available from mobile SDK version 1.7.0 or above.

How to Create and Send In-App Messages

When creating in-app messages, you can easily get started using a variety of pre-built templates we made for you.

After choosing your template, you can easily define in-app message groups and actions.

Display Methods and Grouping

You can manage your in-app messages by grouping them based on the timing of their display. Here are examples:

When customers access the home screen (e.g., home)
When customers access the My Page section (e.g., my page)
When customers make a purchase (e.g., complete_purchase)
When customers create content (e.g., complete_write)

Once the in-app message groups are made, developers can call the 'displayInApp' function at the intended timing within the service to display the appropriate in-app message for the current device. For more details (mobile, web), refer to the platform-specific SDK references.

If the app is WebView-based, the 'displayInApp' function should be executed on the web, and the bridge code must be integrated into the current WebView beforehand.

// Execute the following function when accessing the home screen:
FlareLane.displayInApp("home");

How to Customize Action Buttons

For the buttons in the in-app messages, you can set the following actions:

Name Details

Name	Details
URL	Specify the destination URL, such as an HTTPS link or deep-link, that will be accessed when clicked.
Customized Action	Implement the action to be performed on click using an SDK function. (Requires implementation of `setInAppMessageActionHandler`)
Close	You can also set an option to "Do not show again for N days."
Opt-in Request	Display a prompt for push notification permission or redirect to the settings page.

URL

Specify the destination URL, such as an HTTPS link or deep-link, that will be accessed when clicked.

Customized Action

Implement the action to be performed on click using an SDK function. (Requires implementation of setInAppMessageActionHandler)

You can also set an option to "Do not show again for N days."

Opt-in Request

Display a prompt for push notification permission or redirect to the settings page.

Send Test Messages

To test the in-app message on an actual device, click the Send to Test Device button on the in-app message details page.

The sent message will then be displayed on the device once with the highest priority. At this step, the "Do not show again..." prompt will be overridden.

Display Order

In-app messages within the same group will be displayed according to their priority in the following order:

If there's an in-app message with the highest priority for that device (e.g., a test message or an in-app message from a customer journey automation), it will be displayed first.
Messages will then be shown in order of priority (High > Medium > Low).
The messages with identical priority will be shown in order of creation date, with older messages displayed first.

How to Create Custom In-App Message (HTML)

If you need a unique in-app message design and functionality, you can create an HTML-based in-app message yourself.

You have the flexibility to design the UI by writing HTML code, and after implementing click listeners for the provided buttons, you can integrate the script as follows:

Function	Explanation and Example
FlareLaneIAM.trackEvent(name, data)	Trigger an event.
FlareLaneIAM.setTags(tags)	Integrate tags.
FlareLaneIAM.openUrl(url)	Open a specific URL.
FlareLaneIAM.requestPushPermission()	Request permission for push notification opt-ins.
FlareLaneIAM.executeAction(actionId)	Perform a custom action.

Function

Explanation and Example

FlareLaneIAM.trackEvent(name, data)

Trigger an event.

FlareLaneIAM.setTags(tags)

Integrate tags.

FlareLaneIAM.openUrl(url)

Open a specific URL.

FlareLaneIAM.requestPushPermission()

Request permission for push notification opt-ins.

FlareLaneIAM.executeAction(actionId)

Perform a custom action.

Performance

Metrics (event-based)

You can measure the count of events regardless of user ID.

Metrics	Details
Impressions	Total impressions during the period
Clicks	Total clicks during the period
Click Rate	Clicks / Impressions
Conversions	Total click to conversion count during the period
Conversion Rate	Conversions / Clicks
Total Revenue	Total conversion > purchase amount during the period

Metrics

Details

Impressions

Total impressions during the period

Clicks

Total clicks during the period

Click Rate

Clicks / Impressions

Conversions

Total click to conversion count during the period

Conversion Rate

Conversions / Clicks

Total Revenue

Total conversion > purchase amount during the period

Metrics (User-Based)

You can calculate a unique user count based on members who have a valid user ID.

Metrics	Details
Users Reached	Unique users with impressions during the period
Clicks	Total clicks during the period
Click Rate	Clicks / Impressions
Conversions	Total click to conversion count during the period
Conversion Rate	Conversions / Clicks
Total Revenue	Total conversion > purchase amount during the period