OneSignal Help & Documentation

Welcome to the OneSignal New IA developer hub. You'll find comprehensive guides and documentation to help you start working with OneSignal New IA as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Discussions

In-App Messaging Overview

How to set up In-App Messaging

In-App Messages are highly customizable pop-up modals that any subscribed or unsubscribed Mobile App user can receive when they are inside your app. In-app is not supported on web.

These are different from push notifications in that:

  1. they do not require subscription
  2. they only show when the user is in-app

Getting Started

Sending In-App Messages is easy with OneSignal.

  1. If you haven't already, sign up for a free account on onesignal.com.

  2. Follow the OneSignal Mobile SDKs Setup Guide based on the SDK you are using. Or update your OneSignal SDK to be on the latest version.

  3. Test your app to make sure users are showing up in the All Users Tab

  4. Start sending In-App Messages from the OneSignal Dashboard under Messages > In-App. Use OneSignal's pre-created In-App Message Templates to delight your users by quickly sending visually-appealing messages.

  5. Optional: Setup In-App Message Triggers to show the message whenever you want.

  6. Optional: Add the In-App Message Click Handler to perform custom events when a message element is clicked.

🚧

In-App Message Limitations

Currently In-App Messages are not available to create or trigger through the API and do not show up on Websites.

Free Accounts can setup 1 Live In-App Message at a time.

Supported SDKs

We recommend using the latest version of the OneSignal SDK to get all the latest features available.

SDK

Minimum SDK Version

Details

Android Native SDK

3.11.4

Supported

iOS Native SDK

2.11.2

Supported

React Native SDK

3.4.2

Supported

Unity SDK

2.9.0

Supported

Cordova/Ionic/PhoneGap SDK

2.6.0

Supported

Xamarin SDK

3.5.0

Supported

Flutter SDK

2.1.0

Supported

Web Push SDK

NA

Not Supported

In-App Message Analytics

Impressions tracks how many times the message shows. While Unique Clicks are how many times it has been interacted with by a new user. Clicks are how many total times it has been interacted with. Track which element on the message was clicked like a button, image or background. Include Data Tags and Outcomes within the clickable elements to setup and track events within the app!

FAQ

What is the minimum Android Version that can receive in-app messages?

The minimum Android version that can receive in-app messages is 4.4
If a device is under this version the in-app message will not show.

What is the minimum iOS Version that can receive in-app messages?

The minimum iOS version that can receive in-app messages is 10.0
If a device is under this version the in-app message will not show.

Why is In-App Messaging not working on my app?

The most common reason for IAM not working is you have an older version of the OneSignal SDK in your app. Please follow these steps:
1 - We recommend updating to the latest version of the OneSignal SDK. See above Supported SDK Table for exact minimum versions.
2 - Make sure you are testing on a device with the minimum Android or minimum iOS version.
3 - If you are still having issues, use our SDK setLogLevel method to VERBOSE logging in your app. Reproduce the error with this logging and contact [email protected] with the full log from the device.

Updated 14 days ago



In-App Messaging Overview


How to set up In-App Messaging

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.