Quickly integrate OneSignal push notifications into your Android or Kindle Fire app using Android Studio. Follow this guide to add the OneSignal SDK, initialize it correctly, and ensure best practices for setup and customization.
Android push notifications are essential for driving sustained user engagement and retention in your Android app. They empower you to deliver real-time updates, reminders, and personalized messages directly to your users, improving the overall user experience and stickiness of your app. OneSignal leverages Firebase Cloud Messaging (FCM) but is designed to provide even more flexibility and functionality as shown in this guide.
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.
Step-by-step instructions for configuring your OneSignal app.
You can manage multiple platforms (iOS, Android, Huawei, Amazon, Web) under a single OneSignal app.
Create or select your app
Example shows creating a new app.
Set up and activate a platform
Example setting up your first OneSignal app, org, and channel.
Configure platform credentials
Follow the prompts based on your platforms:
Click Save & Continue after entering your credentials.
Choose target SDK
Select the SDK that matches your development platform (e.g., iOS, Android, React Native, Unity), then click Save & Continue.
Select which SDK you are using to be navigated to the docs.
Install SDK and save your App ID
Once your platform is configured, your OneSignal App ID will be displayed. Copy and save this ID—you’ll need it when installing and initializing the SDK.
If collaborating with others, use the Invite button to add developers or teammates, then click Done to complete setup.
Save your App ID and invite additional team members.
Once complete, follow the SDK installation guide for your selected platform to finish integrating OneSignal.
In Android Studio, open your build.gradle.kts (Module: app)
or build.gradle (Module: app)
file and add OneSignal to your dependencies
.
Example shows adding OneSignal to your App's build.gradle.kts file.
After adding the dependency, sync your project:
It’s best practice to initialize OneSignal in the onCreate
method of your Application
class to ensure proper SDK setup across all entry points.
How to create an Application class
Create a new class (example: ApplicationClass
) and add the following code.
Example ApplicationClass.kt file.
Open your app’s AndroidManifest.xml
In your <application>
tag add android:name=".ApplicationClass"
(replace .ApplicationClass
with your actual class name if set it to something different).
AndroidManifest.xml with the .ApplicationClass name.
In your ApplicationClass
, initialize OneSignal with the provided methods.
Replace YOUR_APP_ID
with your OneSignal App ID found Settings > Keys & IDs in your OneSignal dashboard. If you don’t have access to the OneSignal app, ask your Team Members to invite you.
ApplicationClass.kt file with OneSignal code added.
Initializing in an Activity
(like MainActivity
) is not recommended because it may not be called on app cold-starts from deep links or notifications. Always initialize OneSignal in your Application
class for reliability.
We recommend configuring your notification icons to match your app’s branding. Otherwise, OneSignal will use a default bell icon.
This guide helps you verify that your OneSignal SDK integration is working correctly by testing push notifications, subscription registration, and in-app messaging.
Launch your app on a test device.
The native push permission prompt should appear automatically if you added the requestPermission
method during initialization.
iOS and Android push permission prompts
Check your OneSignal dashboard
Before accepting the prompt, check the OneSignal dashboard:
Dashboard showing subscription with 'Never Subscribed' status
Return to the app and tap Allow on the prompt.
Refresh the OneSignal dashboard Subscription's page.
The subscription’s status should now show Subscribed.
Dashboard showing subscription with 'Subscribed' status
Test subscriptions are helpful for testing a push notification before sending a message.
Add to Test Subscriptions.
In the dashboard, next to the subscription, click the Options (three dots) button and select Add to Test Subscriptions.
Adding a device to Test Subscriptions
Name your subscription.
Name the subscription so you can easily identify your device later in the Test Subscriptions tab.
Dashboard showing the 'Name your subscription' field
Create a test users segment.
Go to Audience > Segments > New Segment.
Name the segment.
Name the segment Test Users
(the name is important because it will be used later).
Add the Test Users filter and click Create Segment.
Creating a 'Test Users' segment with the Test Users filter
Get your App API Key and App ID.
In your OneSignal dashboard, go to Settings > Keys & IDs.
Update the provided code.
Replace YOUR_APP_API_KEY
and YOUR_APP_ID
in the code below with your actual keys. This code uses the Test Users
segment we created earlier.
Run the code.
Run the code in your terminal.
Check images and confirmed delivery.
If all setup steps were completed successfully, the test subscriptions should receive a notification with an image included:
Push notification with image on iOS and Android
Check for confirmed delivery.
In your dashboard, go to Delivery > Sent Messages, then click the message to view stats.
You should see the confirmed stat, meaning the device received the push.
Delivery stats showing confirmed delivery
If you’re on a Professional plan or higher, scroll to Audience Activity to see subscription-level confirmation:
Confirmed delivery at the device level in Audience Activity
.txt
file. Then share both with support@onesignal.com
.In-app messages let you communicate with users while they are using your app.
Close or background your app on the device.
This is because users must meet the in-app audience criteria before a new session starts. In OneSignal, a new session starts when the user opens your app after it has been in the background or closed for at least 30 seconds. For more details, see our guide on how in-app messages are displayed.
Create an in-app message.
Targeting the 'Test Users' segment with an in-app message
Customize the message content if desired.
Example customization of in-app Welcome message
Set Trigger to 'On app open'.
Schedule frequency.
Under Schedule > How often do you want to show this message? select Every time trigger conditions are satisfied.
In-app message scheduling options
Make message live.
Click Make Message Live so it is available to your Test Users each time they open the app.
Open the app and see the message.
After the in-app message is live, open your app. You should see it display:
Welcome in-app message shown on devices
Not seeing the message?
Test Users
segment?
support@onesignal.com
and we will help investigate what’s going on.You have successfully setup the OneSignal SDK and learned important concepts like:
Continue with this guide to identify users in your app and setup additional features.
Previously, we demonstrated how to create mobile Subscriptions. Now we’ll expand to identifying Users across all their subscriptions (including push, email, and SMS) using the OneSignal SDK. We’ll cover External IDs, tags, multi-channel subscriptions, privacy, and event tracking to help you unify and engage users across platforms.
Use an External ID to identify users consistently across devices, email addresses, and phone numbers using your backend’s user identifier. This ensures your messaging stays unified across channels and 3rd party systems (especially important for Integrations).
Set the External ID with our SDK’s login
method each time they are identified by your app.
OneSignal generates unique read-only IDs for subscriptions (Subscription ID) and users (OneSignal ID).
As users download your app on different devices, subscribe to your website, and/or provide you email addresses and phone numbers outside of your app, new subscriptions will be created.
Setting the External ID via our SDK is highly recommended to identify users across all their subscriptions, regardless of how they are created.
Tags are key-value pairs of string data you can use to store user properties (like username
, role
, or preferences) and events (like purchase_date
, game_level
, or user interactions). Tags power advanced Message Personalization and Segmentation allowing for more advanced use cases.
Set tags with our SDK addTag
and addTags
methods as events occur in your app.
In this example, the user reached level 6 identifiable by the tag called current_level
set to a value of 6
.
A user profile in OneSignal with a tag called "current_level" set to "6"
We can create a segment of users that have a level of between 5 and 10, and use that to send targeted and personalized messages:
Segment editor showing a segment targeting users with a current_level value of greater than 4 and less than 10
Screenshot showing a push notification targeting the Level 5-10 segment with a personalized message
The push notification is received on an iOS and Android device with the personalized content
Earlier we saw how our SDK creates mobile subscriptions to send push and in-app messages. You can also reach users through emails and SMS channels by creating the corresponding subscriptions.
addEmail
method to create email subscriptions.addSms
method to create SMS subscriptions.If the email address and/or phone number already exist in the OneSignal app, the SDK will add it to the existing user, it will not create duplicates.
You can view unified users via Audience > Users in the dashboard or with the View user API.
A user profile with push, email, and SMS subscriptions unified by External ID
Best practices for multi-channel communication
To control when OneSignal collects user data, use the SDK’s consent gating methods:
setConsentRequired(true)
: Prevents data collection until consent is given.setConsentGiven(true)
: Enables data collection once consent is granted.See our Privacy & security docs for more on:
Instead of calling requestPermission()
immediately on app open, take a more strategic approach. Use an in-app message to explain the value of push notifications before requesting permission.
For best practices and implementation details, see our Prompt for push permissions guide.
Use SDK listeners to react to user actions and state changes.
The SDK provides several event listeners for you to hook into. See our SDK reference guide for more details.
addClickListener()
: Detect when a notification is tapped. Helpful for Deep Linking.addForegroundLifecycleListener()
: Control how notifications behave in foreground.For full customization, see Mobile Service Extensions.
addObserver()
for user state: Detect when the External ID is set.addPermissionObserver()
: Track the user’s specific interaction with the native push permission prompt.addObserver()
for push subscription: Track when the push subscription status changes.addClickListener()
: Handle in-app click actions. Ideal for deep linking or tracking events.addLifecycleListener()
: Track full lifecycle of in-app messages (shown, clicked, dismissed, etc.).Explore more capabilities to enhance your integration:
Make sure you’ve enabled all key features by reviewing the Mobile push setup guide.
For full details on available methods and configuration options, visit the Mobile SDK reference.
Android 12 and higher enforce system templates for custom notifications. However, you can still customize your layout using Android’s standard notification styles.
To customize your layout:
When a notification is clicked, OneSignal will resume your app, or open your launcher Activity if your app was swiped away. To prevent OneSignal from auto-opening your launcher Activity when a notification is clicked, add this to your AndroidManifest.xml
:
You must implement a custom Notification Opened Listener in the onCreate
method in your Application
class. You will need to call startActivity
from this callback to take the user to your intended Activity
.
To support RTL languages in notifications and UI, add this to your AndroidManifest.xml
:
Make sure to test all Activities and views to verify correct RTL behavior. See Android’s documentation on localizing your app for more information.
Need help?
Chat with our Support team or email support@onesignal.com
Please include:
We’re happy to help!
Quickly integrate OneSignal push notifications into your Android or Kindle Fire app using Android Studio. Follow this guide to add the OneSignal SDK, initialize it correctly, and ensure best practices for setup and customization.
Android push notifications are essential for driving sustained user engagement and retention in your Android app. They empower you to deliver real-time updates, reminders, and personalized messages directly to your users, improving the overall user experience and stickiness of your app. OneSignal leverages Firebase Cloud Messaging (FCM) but is designed to provide even more flexibility and functionality as shown in this guide.
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.
Step-by-step instructions for configuring your OneSignal app.
You can manage multiple platforms (iOS, Android, Huawei, Amazon, Web) under a single OneSignal app.
Create or select your app
Example shows creating a new app.
Set up and activate a platform
Example setting up your first OneSignal app, org, and channel.
Configure platform credentials
Follow the prompts based on your platforms:
Click Save & Continue after entering your credentials.
Choose target SDK
Select the SDK that matches your development platform (e.g., iOS, Android, React Native, Unity), then click Save & Continue.
Select which SDK you are using to be navigated to the docs.
Install SDK and save your App ID
Once your platform is configured, your OneSignal App ID will be displayed. Copy and save this ID—you’ll need it when installing and initializing the SDK.
If collaborating with others, use the Invite button to add developers or teammates, then click Done to complete setup.
Save your App ID and invite additional team members.
Once complete, follow the SDK installation guide for your selected platform to finish integrating OneSignal.
In Android Studio, open your build.gradle.kts (Module: app)
or build.gradle (Module: app)
file and add OneSignal to your dependencies
.
Example shows adding OneSignal to your App's build.gradle.kts file.
After adding the dependency, sync your project:
It’s best practice to initialize OneSignal in the onCreate
method of your Application
class to ensure proper SDK setup across all entry points.
How to create an Application class
Create a new class (example: ApplicationClass
) and add the following code.
Example ApplicationClass.kt file.
Open your app’s AndroidManifest.xml
In your <application>
tag add android:name=".ApplicationClass"
(replace .ApplicationClass
with your actual class name if set it to something different).
AndroidManifest.xml with the .ApplicationClass name.
In your ApplicationClass
, initialize OneSignal with the provided methods.
Replace YOUR_APP_ID
with your OneSignal App ID found Settings > Keys & IDs in your OneSignal dashboard. If you don’t have access to the OneSignal app, ask your Team Members to invite you.
ApplicationClass.kt file with OneSignal code added.
Initializing in an Activity
(like MainActivity
) is not recommended because it may not be called on app cold-starts from deep links or notifications. Always initialize OneSignal in your Application
class for reliability.
We recommend configuring your notification icons to match your app’s branding. Otherwise, OneSignal will use a default bell icon.
This guide helps you verify that your OneSignal SDK integration is working correctly by testing push notifications, subscription registration, and in-app messaging.
Launch your app on a test device.
The native push permission prompt should appear automatically if you added the requestPermission
method during initialization.
iOS and Android push permission prompts
Check your OneSignal dashboard
Before accepting the prompt, check the OneSignal dashboard:
Dashboard showing subscription with 'Never Subscribed' status
Return to the app and tap Allow on the prompt.
Refresh the OneSignal dashboard Subscription's page.
The subscription’s status should now show Subscribed.
Dashboard showing subscription with 'Subscribed' status
Test subscriptions are helpful for testing a push notification before sending a message.
Add to Test Subscriptions.
In the dashboard, next to the subscription, click the Options (three dots) button and select Add to Test Subscriptions.
Adding a device to Test Subscriptions
Name your subscription.
Name the subscription so you can easily identify your device later in the Test Subscriptions tab.
Dashboard showing the 'Name your subscription' field
Create a test users segment.
Go to Audience > Segments > New Segment.
Name the segment.
Name the segment Test Users
(the name is important because it will be used later).
Add the Test Users filter and click Create Segment.
Creating a 'Test Users' segment with the Test Users filter
Get your App API Key and App ID.
In your OneSignal dashboard, go to Settings > Keys & IDs.
Update the provided code.
Replace YOUR_APP_API_KEY
and YOUR_APP_ID
in the code below with your actual keys. This code uses the Test Users
segment we created earlier.
Run the code.
Run the code in your terminal.
Check images and confirmed delivery.
If all setup steps were completed successfully, the test subscriptions should receive a notification with an image included:
Push notification with image on iOS and Android
Check for confirmed delivery.
In your dashboard, go to Delivery > Sent Messages, then click the message to view stats.
You should see the confirmed stat, meaning the device received the push.
Delivery stats showing confirmed delivery
If you’re on a Professional plan or higher, scroll to Audience Activity to see subscription-level confirmation:
Confirmed delivery at the device level in Audience Activity
.txt
file. Then share both with support@onesignal.com
.In-app messages let you communicate with users while they are using your app.
Close or background your app on the device.
This is because users must meet the in-app audience criteria before a new session starts. In OneSignal, a new session starts when the user opens your app after it has been in the background or closed for at least 30 seconds. For more details, see our guide on how in-app messages are displayed.
Create an in-app message.
Targeting the 'Test Users' segment with an in-app message
Customize the message content if desired.
Example customization of in-app Welcome message
Set Trigger to 'On app open'.
Schedule frequency.
Under Schedule > How often do you want to show this message? select Every time trigger conditions are satisfied.
In-app message scheduling options
Make message live.
Click Make Message Live so it is available to your Test Users each time they open the app.
Open the app and see the message.
After the in-app message is live, open your app. You should see it display:
Welcome in-app message shown on devices
Not seeing the message?
Test Users
segment?
support@onesignal.com
and we will help investigate what’s going on.You have successfully setup the OneSignal SDK and learned important concepts like:
Continue with this guide to identify users in your app and setup additional features.
Previously, we demonstrated how to create mobile Subscriptions. Now we’ll expand to identifying Users across all their subscriptions (including push, email, and SMS) using the OneSignal SDK. We’ll cover External IDs, tags, multi-channel subscriptions, privacy, and event tracking to help you unify and engage users across platforms.
Use an External ID to identify users consistently across devices, email addresses, and phone numbers using your backend’s user identifier. This ensures your messaging stays unified across channels and 3rd party systems (especially important for Integrations).
Set the External ID with our SDK’s login
method each time they are identified by your app.
OneSignal generates unique read-only IDs for subscriptions (Subscription ID) and users (OneSignal ID).
As users download your app on different devices, subscribe to your website, and/or provide you email addresses and phone numbers outside of your app, new subscriptions will be created.
Setting the External ID via our SDK is highly recommended to identify users across all their subscriptions, regardless of how they are created.
Tags are key-value pairs of string data you can use to store user properties (like username
, role
, or preferences) and events (like purchase_date
, game_level
, or user interactions). Tags power advanced Message Personalization and Segmentation allowing for more advanced use cases.
Set tags with our SDK addTag
and addTags
methods as events occur in your app.
In this example, the user reached level 6 identifiable by the tag called current_level
set to a value of 6
.
A user profile in OneSignal with a tag called "current_level" set to "6"
We can create a segment of users that have a level of between 5 and 10, and use that to send targeted and personalized messages:
Segment editor showing a segment targeting users with a current_level value of greater than 4 and less than 10
Screenshot showing a push notification targeting the Level 5-10 segment with a personalized message
The push notification is received on an iOS and Android device with the personalized content
Earlier we saw how our SDK creates mobile subscriptions to send push and in-app messages. You can also reach users through emails and SMS channels by creating the corresponding subscriptions.
addEmail
method to create email subscriptions.addSms
method to create SMS subscriptions.If the email address and/or phone number already exist in the OneSignal app, the SDK will add it to the existing user, it will not create duplicates.
You can view unified users via Audience > Users in the dashboard or with the View user API.
A user profile with push, email, and SMS subscriptions unified by External ID
Best practices for multi-channel communication
To control when OneSignal collects user data, use the SDK’s consent gating methods:
setConsentRequired(true)
: Prevents data collection until consent is given.setConsentGiven(true)
: Enables data collection once consent is granted.See our Privacy & security docs for more on:
Instead of calling requestPermission()
immediately on app open, take a more strategic approach. Use an in-app message to explain the value of push notifications before requesting permission.
For best practices and implementation details, see our Prompt for push permissions guide.
Use SDK listeners to react to user actions and state changes.
The SDK provides several event listeners for you to hook into. See our SDK reference guide for more details.
addClickListener()
: Detect when a notification is tapped. Helpful for Deep Linking.addForegroundLifecycleListener()
: Control how notifications behave in foreground.For full customization, see Mobile Service Extensions.
addObserver()
for user state: Detect when the External ID is set.addPermissionObserver()
: Track the user’s specific interaction with the native push permission prompt.addObserver()
for push subscription: Track when the push subscription status changes.addClickListener()
: Handle in-app click actions. Ideal for deep linking or tracking events.addLifecycleListener()
: Track full lifecycle of in-app messages (shown, clicked, dismissed, etc.).Explore more capabilities to enhance your integration:
Make sure you’ve enabled all key features by reviewing the Mobile push setup guide.
For full details on available methods and configuration options, visit the Mobile SDK reference.
Android 12 and higher enforce system templates for custom notifications. However, you can still customize your layout using Android’s standard notification styles.
To customize your layout:
When a notification is clicked, OneSignal will resume your app, or open your launcher Activity if your app was swiped away. To prevent OneSignal from auto-opening your launcher Activity when a notification is clicked, add this to your AndroidManifest.xml
:
You must implement a custom Notification Opened Listener in the onCreate
method in your Application
class. You will need to call startActivity
from this callback to take the user to your intended Activity
.
To support RTL languages in notifications and UI, add this to your AndroidManifest.xml
:
Make sure to test all Activities and views to verify correct RTL behavior. See Android’s documentation on localizing your app for more information.
Need help?
Chat with our Support team or email support@onesignal.com
Please include:
We’re happy to help!