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

Mobile SDKs API Migration Guides

Major SDK Versions Summary

We've refined our SDKs' API to be more straightforward for common use cases while providing more flexibility for advanced ones. Better defaults and removing deprecated APIs means less code is required to set up notifications and a more focused set of options to look through.

Dependency changes including switching to AndroidX means better compatibility with projects.

Based on user feedback, we’ve added a new notificationWillShowInForeground API enabling you to decide if the specific notification you’re about to show should be when your app is in the foreground. It’s really useful to not interrupt your users while they are in the middle of an intense battle in your game, or for a chat app, to not display a notification when the user is a already in the chat. See "Android - Foreground Notification Control" and "iOS - Foreground Notification Control" for more details on this new API.

Released SDKs


Step-by-Step Migration Guides

Just required changes to get upgraded to the major versions quickly!

Full API Changes References

New App Setup guide

If you are adding the OneSignal SDK to the app for the first time.

:hammer: Beta SDKs


Give them a try and provide feedback via our Github repos on the specific SDK you're trying out!

See our Mobile Push Quickstart if you would like to use the main line SDKs.

Step-by-Step Migration Guides

Just required changes to get upgraded to the major versions quickly!

  • Unity, Cordova and others coming soon

Full API Changes References

  • Unity, Cordova, and others coming soon

New App Setup guide

If you are adding the OneSignal SDK to the app for the first time.

  • Unity, Cordova, and others coming soon

Updated about a month ago


Mobile SDKs API Migration Guides


Suggested Edits are limited on API Reference Pages

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