OneSignal Setup

Video Tutorial

Android Setup

Step 1 - Create A Firebase Project:

Push Notifications require a Firebase Project. If you don't have one setup yet, click Add project and follow the directions to setup your project.

If you already have an FCM project, skip to Step 2.

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

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

Under "Cloud Messaging API (Legacy)" click on the options (three dots on the right) and click "Manage API in Google Cloud Console".

This will open a new page, under Cloud Messaging press "Enable".

Refresh the page on your Firebase Console and copy your Server key and Sender ID.

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

In the OneSignal dashboard, select your app, then go to:

Settings > Platforms > Google Android

Paste your Firebase Server Key and Firebase Sender ID into the fields and click Next all the way to Save.

Step 4. Configure Your OneSignal App's Android Platform Settings

Update in Admin Panel only

iOS Setup

Generate an iOS Push Certificate

Step-by-step guide to create an iOS Push Certificate

An iOS Push Certificate is required for notification delivery to all iOS apps.

Step 1 - Requirements:

  • An iOS mobile app. (This is not for websites / web push)

  • A OneSignal Account, if you do not already have one.

  • A Mac computer with Xcode 11+

  • Your Xcode project should have the Push Notification capability added. Otherwise your project may not be shown in the Apple Developer Center.

Step 2 - Create a Certificate Request Manually:

2.1 - Request a Certificate From a Certificate Authority

Open the Keychain Access app on your macOS system. It may be located in Applications > Utilities > Keychain Access.

Select Keychain Access > Certificate Assistant > Request a Certificate From a Certificate Authority...

Next, select the Save to disk option and enter your information in the required fields.

This creates a certification request file that will be used later.

2.2 - Add Capabilities

Select Identifiers in your Apple Developer Account under Certificates, IDs & Profiles > Identifiers

Find and select your Identifier to enable Push Notifications, but do not click Edit.

If you do not see your Identifier, follow below Optional - Provisioning Profiles step.

2.3 - Select Push Notification Certificate

Next, go to Certificates and create a new certificate by clicking the blue + (plus) button.

Under Services, select Apple Push Notification service SSL (Sandbox & Production) and click Continue.

  • The certificate will be applicable to both Sandbox and Production environments, so you do not need a separate key for each one.

2.4 - Select your App

Choose your App ID with matching Bundle ID from the App ID pop-up menu, and click Continue.

2.5 - Upload your Certificate Signing Request

Click Choose File.., select the CertSigningRequest file you saved in Step 2.1, click Open, and then click Continue.

Click Download to save the certificate to your computer.

2.6 - Creating a Private Key

Open the .cer file you downloaded in the last step by double-clicking on it in Finder.

After a few seconds, the Keychain Access program should open. Select Login > My Certificates, then right-click on your Apple Push Services key in the list and select Export "Apple Push Services....

Give the file a unique name using the .p12 extension, and click Save. You will have an option to protect the file with a password. If you add a password, you need to enter this same password on OneSignal.

Step 3 - Upload Your Push Certificate to OneSignal

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

Select the .p12 file you exported (along with a password, if you added one) and click Save.

Note: If you used the OneSignal Provisionator tool to create a .p12 file, a password was generated for you, and is located next to the Download button.

Optional - Provisioning Profiles

Usually Required for Cordova/Ionic, and GoNative.

Skip if selected "Automatically manage signing" in Xcode.

If you did not select "Automatically manage signing", then follow these steps.

Create your Identifier

In your Apple Developer Account, go to Identifiers and select the Blue + button

Select App IDs and Continue

Select App and Continue

Provide a "Description" and your Explicit "Bundle ID" then press Continue

Click Register

Create Your Profile

In your Apple Developer Account, on the left to go to Profiles.

Next find any that are for your app and remove them if they do not have App Groups and Push Notifications in Enabled Capabilities:

Create a Profile by pressing the "+" button

Select the type of profile you need to create and press Continue

Search for your App ID, if you do not see your App ID, check the Create Your Identifier step above.

Then press Continue.

Select the Development or Distribution Certificate to associate with the Profile. Then click Continue.

Config Badge

https://documentation.onesignal.com/docs/badges#ios-badge-behavior

Last updated