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 Quickstart

How to set up In-App Messaging

In-App Messages are highly customizable pop-up modals that any mobile app user (subscribed or unsubscribed) 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

SDK Limitations

Currently In-App Messaging is only available for with the OneSignal Mobile SDKs.

Website In-App Messaging is not available.

Supported SDKs

Make sure you have the minimum SDK version or higher installed. We recommend using the latest version of the OneSignal SDK.

SDK
Minimum SDK Version
Details

Supported

Supported

Supported

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. More details in Sending In-App Messages.

API Limitations

Currently In-App Messages are not available through the API.

FAQ

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, see our Mobile SDK Reference for your SDK and add the setLogLevel method to VERBOSE logging in your app. Then contact support@onesignal.com and provide the full log from the device.

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.


In-App Messaging Quickstart


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.