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 Messages Quickstart

In-App messages allow you to target your users when using your applications.

In-App Messages are highly customizable pop-up modals that Mobile App user can receive when they are inside your App. This guide will go over how to set them up and all features available.

In-App messages do not require subscription, and they only show when the users are actively using your application. This enables In-App messages to be highly effective in some of the following scenarios:

  1. Onboarding: Guide your users through getting started with your application. Provide them with an onboarding process, introducing them to key application features
  2. Product and Feature Announcements: Inform your users when you have added new products and features to the application, to capture their attention to begin using them.
  3. Push and Location Access: Get users to subscribe to push or grant location access needed for your application.
  4. Refer a Friend: Allow your users to invite their friends into your application in a single click.

Getting Started

  1. Sign up for a free OneSignal Account.
  2. Setup your SDK, with our handy Mobile Push Quickstart guides.
  3. Add your users and ensure they are present in Audience > All Users.
  4. Send an In-App Message using our creator tool. You can find this under Messages > In-App. Feel free to use our In-App Message Templates to delight your users by quickly sending visually-appealing messages.
  5. Learn how to set up an In-App Message Triggers to show your message and In-App Message Click handler to perform custom events when messages are clicked.


OneSignal has five out-of-the-box In-App templates for you to quickly get started. These templates are professionally designed with rich-media content to help you deliver a quality experience to your app users. These include: Welcome Message, Push Permission Prompt, Promotions, New Feature Announcements, and App Store Rating request.

You can customize these templates with your own branding and set them to an active state in a few minutes.

Testing In-App Messages

Navigate to Messages > In-App > Actions > Edit.

Make any changes and when ready to test, click Send to Test Device. This will send your device a push notification that you can click to open your app and preview the IAM updates.

  • Push Notifications are not sent when in production. Push is only sent when clicking Send to Test Device.
  • Testing In-App Messages requires Push Subscription. Push Subscription is not required in production.
  • If you are not a test user, see Find Devices & Set Test Users.

Updated 6 days ago

In-App Messages Quickstart

In-App messages allow you to target your users when using your applications.

Suggested Edits are limited on API Reference Pages

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