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

Generate a Firebase Server Key

Step-by-step guide

Do not follow this guide if you are using OneSignal with a website or WordPress blog.

A Google Firebase Server Key is required for all Android mobile apps and Chrome apps & extensions. It is optional for Amazon apps.

What is a Firebase Server Key?

A Firebase Server Key and Firebase Sender ID are required in order to send push notifications to Android mobile app devices.

The goal of this section is to provision your Firebase Server Key and Firebase Sender ID for use in OneSignal.

Requirements

  • An Android mobile app, Chrome app or extension, or an Amazon app. This is not for websites.
  • A Google account
  • A OneSignal Account, if you do not already have one.

Step 1: Create A Firebase Project

If you already have an FCM project you would like to use with OneSignal, you will need to retrieve your Sender ID and Firebase Cloud Messaging token. You may then skip to Step 2.

Visit the Firebase Console and sign in with your Google account.

Click CREATE NEW PROJECT or select an existing one below.

Enter a project name and press CREATE PROJECT.


Step 2: Getting Your Firebase Cloud Messaging Token And Sender ID

Click the gear icon in the top left and select Project settings.

Select the CLOUD MESSAGING tab.

Save the two values listed under Server key and Sender ID.


Step 3: Configure Your OneSignal App's Android Platform Settings

In the OneSignal dashboard, select your app from the All Apps page, then go to Settings. Under Native App Platforms, click Google Android.

Paste your Firebase Server Key and Firebase Sender ID into the fields and click Save.


Done! You now have a key to send push notifications from your app. 🥳

Next, install the OneSignal SDK in your app. If you need help, we have a few SDK-specific guides:

Updated about a month ago


Generate a Firebase Server Key


Step-by-step guide

Suggested Edits are limited on API Reference Pages

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