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    Support

Android Notification Icons

Adding custom icons to some or all of your notifications. Works with Android (and derivatives like Amazon).

For Developers

Icons are a way to provide a more unique, branded experience for your Android and Amazon app. Note that iOS doesn't support custom icons, as it uses the app icon for all notifications.

You may add a default icon that appears with every notification you send, or you may add icons to just certain types of notifications. The below tutorial shows you how to do both.

About Notification Icons

Android supports both Small and Large Notification Icons.

Small Notification Icons - by default our SDK automatically uses either a white bell icon or your App's launcher icon. Starting with Android 5, the OS forces Small Notification Icons to be all white when your app targets Android API 21+. If you don't make a correct icon, it will most likely be displayed as a bell or solid white icon in the status bar.

Large Notification Icons - The large notification icon will show up to the left of the notification text on Android 3.0+ devices. If you do not set a large icon, the small icon will be used instead. OneSignal will auto scale large notification icons for you to prevent the icon from being cropped.

How to Add Default Icons

We strongly recommend adding default icons to every Android and Amazon app.

1. Generate Icons

Option A: Using Android Asset Studio

Recommended

To quickly and easily generate small icons with the correct settings, we recommend using the Android Asset Studio. Use ic_stat_onesignal_default as the name.

Option B: Manually Create Icons

Not Recommended

If you prefer to create your own icons, you must make your icons the following size and colors:

Type
Size (px)

Small Notification Icon

24x24

Small Notification Icon

36x36

Small Notification Icon

48x48

Small Notification Icon

72x72

Large Notification Icon

256x256

2.Create project paths

Make sure the following paths exist, create any folders you are missing.

SDK
File path

Android Native

res/drawable-mdpi/ (24x24)
res/drawable-hdpi/ (36x36)
res/drawable-xhdpi/ (48x48)
res/drawable-xxhdpi/ (72x72)
res/drawable-xxxhdpi/ (256x256) (Large Icon)

Unity

Assets/Plugins/Android/OneSignalConfig/res/drawable-mdpi/ (24x24)
Assets/Plugins/Android/OneSignalConfig/res/drawable-hdpi/ (36x36)
Assets/Plugins/Android/OneSignalConfig/res/drawable-xhdpi/ (48x48)
Assets/Plugins/Android/OneSignalConfig/res/drawable-xxhdpi/ (72x72)
Assets/Plugins/Android/OneSignalConfig/res/drawable-xxxhdpi/ (256x256) (Large Icon)

PhoneGap, Cordova, Ionic

<project-root>/platforms/android/res/drawable-hdpi/ (36x36)
<project-root>/platforms/android/res/drawable-xhdpi/ (48x48)
<project-root>/platforms/android/res/drawable-xxhdpi/ (72x72)
<project-root>/platforms/android/res/drawable-xxxhdpi/ (256x256) (Large Icon)

Ionic Package
(Cloud Build)

<project-root>/resources/android/custom/ (72x72)
<project-root>/resources/android/custom/ (256x256) (Large Icon)

Must also add 'ionic-package-hooks` to your project.
As well as follow it's android_custom_values.js instructions.

PhoneGap Build (PGB)

<project-root>/locales/android/drawable-hdpi/ (36x36)
<project-root>/locales/android/drawable-xhdpi/ (48x48)
<project-root>/locales/android/drawable-xxhdpi/ (72x72)
<project-root>/locales/android/drawable-xxxhdpi/ (256x256) (Large Icon)

See this github link for more details on the directory structure if you're having issues.

Intel XDK

Limited, see this work around

Corona

Add files to root (all sizes)

3. Name Icons Appropriately

Next, you must be sure the icon filenames are correct. If you used Android Asset Studio for your small icon then this step may have already been done for you.

Android 3.0+

SDK
Filename

Native, Unity,
PhoneGap, Cordova, Ionic,
PhoneGap Build (PGB)

/drawable-[SIZE_NAMES]/ic_stat_onesignal_default.png
/drawable-xxxhdpi/ic_onesignal_large_icon_default.png (Large Icon)

Ionic Package
(Cloud Build)

<project-root>/resources/android/custom/ic_stat_onesignal_default (72x72) (small icon)
<project-root>/resources/android/custom/ic_onesignal_large_icon_default (256x256) (large icon)

Corona

IconNotificationDefault-mdpi-v11.png (24x24)
IconNotificationDefault-hdpi-v11.png (36x36)
IconNotificationDefault-xhdpi-v11.png (48x48)
IconNotificationDefault-xxhdpi-v11.png (72x72)
ic_onesignal_large_icon_default.png (256x256)(Large Icon)

Android 2.3

SDK
Filename

Native, Unity,
PhoneGap, Cordova, Ionic,
PhoneGap Build (PGB)

/drawable-[SIZE_NAMES]/ic_stat_onesignal_default.png (all small icon sizes)

Corona

IconNotificationDefault-mdpi.png (24x24)
IconNotificationDefault-hdpi.png (36x36)
IconNotificationDefault-xhdpi.png (48x48)
IconNotificationDefault-xxhdpi.png (72x72)

Done! You should be all set with your new default icons


How to Add Non-Default Icons

Optional

After you've added your default icons, you may choose to add more non-default icons. These will let you show different icons depending on the types of notifications your app sends. For instance, a game with a title like "Jewel Breaker" may wish to have a different colored jewel icon for every notification sent that represents the player's level. Meanwhile, a social network may wish to show a chat bubble icon when the user receives a message from another user to differentiate those notifications from more generic system notifications.

OneSignal supports overriding default icons on a per-message basis.

1. Generate Icons

Follow the steps above to generate icons and place them in the appropriate folder for your SDK.

2. Name Non-Default Icons

To add non-default icons, you must name them something other than the default names specified above. For instance, you may name one message_icon.

3. Send Notifications with Non-Default Icons

If you've followed the above steps for creating default icons, and have updated your app, you'll be able to reference those icons when you send a notification. To send a notification with an icon, within New Message open Android Options, and specify the icon to use.

Do not add the file extension when referencing the icon file. For instance, in the below example the file is referenced as message_icon.

With Large Notification Icons, you can also supply a URL where the icon will be displayed from.

REST API - Instead of sending via the dashboard, you can send notifications with icons in the REST API by using the appropriate parameter and file extension depending on your platform (see more in Create notification REST API docs).

New icons take a while to propagate to all users

If you've very recently added an icon resource to your app, you may want to wait a few days before sending notifications using the icon. This is because it can take many days or even weeks for the majority of your users to update their apps to the latest version which contain your new icons.

Android Notification Icons

Adding custom icons to some or all of your notifications. Works with Android (and derivatives like Amazon).

For Developers