Overview

The following guides will help you set up the OneSignal SDK in your mobile apps. For websites, see Web Setup.

For each platform your mobile app supports, you’ll need to establish a connection with FCM (Android), APNS (iOS), HMS (Huawei), and/or ADM (Amazon). Use the options below to configure your OneSignal App and Platform.

Configure your OneSignal app and platform

Required setup for push notifications

To start sending push notifications with OneSignal, you must first configure your OneSignal app with all the platforms your support—Apple (APNs), Google (FCM), Huawei (HMS), and/or Amazon (ADM).

If your organization already has a OneSignal account, ask to be invited as an admin role to configure the app. Otherwise, sign up for a free account to get started.


SDK setup guides

Integrations


FAQ

Are the SDKs required?

No, but they’re highly recommended — and open source on GitHub.

You can integrate OneSignal using only our server-side APIs, but using our SDKs simplifies and streamlines the process, especially for handling push notifications across platforms.

What you can do without the SDK:

You can use the following APIs directly:

If you plan to use In-app messages, our SDK is required.

Why we recommend using the SDKs:

Push notifications have platform-specific requirements that our SDKs handle for you, including:

  • Obtaining push tokens across Android, iOS, Huawei, and Web
  • Managing subscription status and user prompts for opt-in
  • Displaying and processing push notifications on the client

Apple’s APNS and Google’s FCM use different payload formats. OneSignal notifications include a custom payload that our SDK parses to display and track messages accurately.

Maintaining this manually adds complexity. Learn more: Build vs. Buy: What Goes Into Building a Push Notification Platform

Can devices in China receive push notifications?

If the device has Google Play Services/Store, it will receive push notifications through FCM (Firebase Cloud Messaging).

If the app was downloaded from the Huawei AppGallery, it will receive push notifications through HMS (Huawei Messaging Service). You will need to setup our Huawei SDK.

OneSignal defaults to FCM for devices that support both HMS and FCM. You can setup the Huawei SDK to prefer HMS over FCM.

Can non-HarmonyOS Huawei devices running Android receive push from OneSignal?

Yes, non-HarmonyOS Huawei devices running Android can still use our Huawei SDK.