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

Cordova SDK Setup

OneSignal Cordova SDK Setup Guide. Works with iOS, Android (and derivatives like Amazon) and Windows Phone 8.1.

For Developers

Update SDK

If you already have an app with the Cordova SDK, you can run this to ensure your SDK is on the latest version:

cordova plugin update onesignal-cordova-plugin

If you have not set up an app yet, follow the instructions below.


Setup SDK

Generate Credentials

Before setting up the Cordova SDK, you must generate the appropriate credentials for the platform(s) you are releasing on:

iOS - Generate an iOS Push Certificate

Android - Generate a Google Server API Key

Amazon - Generate an Amazon API Key

Windows Phone 8.1 - Generate a Windows Phone Package SID and Secret

1. Import OneSignal Plugin

Recommend using Cordova 6.4.0 or newer and iOS platform 4.3.1 or newer
Please follow step 1A or 1B based how you build your app.

You should also remove other Push SDKs that you are not using, otherwise you may see duplicate notifications.

1A. Import from the Terminal

Run the following from your project directory.

cordova plugin add onesignal-cordova-plugin
# Cordova 4 has a number of security holes, recommend updating to the latest version.

cordova plugin add https://github.com/one-signal/OneSignal-Cordova-SDK.git#PGB-Compat

# Android - require "Google Play services" and "Android Support Library v4" to be included with your app.
# Add the following plugins if you do not have them in your app already from another plugin.
https://github.com/floatinghotpot/google-play-services
https://github.com/floatinghotpot/cordova-plugin-android-support-v4

-- OR --

1B. Visual Studio

1. Open your project's config.xml and select Platforms. Make sure you have Cordova CLI 6.4.0 or higher.

2. Right click on config.xml and select "View Code".
3. Add the following to the file:

  <vs:features>
    <vs:feature>onesignal-cordova-plugin</vs:feature>
  </vs:features>

2. Add required code

2.1. Add the following to the first javascript file that loads with your app.

  • This is <project-dir>/www/js/index.js for most Cordova projects.
// Add to index.js or the first page that loads with your app.
// For Intel XDK and please add this to your app.js.

document.addEventListener('deviceready', function () {
  // Enable to debug issues.
  // window.plugins.OneSignal.setLogLevel({logLevel: 4, visualLevel: 4});
  
  var notificationOpenedCallback = function(jsonData) {
    console.log('notificationOpenedCallback: ' + JSON.stringify(jsonData));
  };

  window.plugins.OneSignal
    .startInit("YOUR_APPID")
    .handleNotificationOpened(notificationOpenedCallback)
    .endInit();
  
  // Call syncHashedEmail anywhere in your app if you have the user's email.
  // This improves the effectiveness of OneSignal's "best-time" notification scheduling feature.
  // window.plugins.OneSignal.syncHashedEmail(userEmail);
}, false);

2.2 Update initialization parameters

Replace YOUR_APPID with your OneSignal AppId, available in Keys & IDs

3. Android

3.1 Open the Android SDK Manager.

3.2 Make sure to install and update the following under Extras:

  • Android Support Repository
  • Google Repository

3.3 Follow the Customize Notification Icons instructions to create a small notification icon required for Android 5.0+ devices.

4. Amazon ADM

Place your api_key.txt file into your <project-dir>/platforms/android/assets/ folder.

To create an api_key.txt for your app follow our Generate an Amazon API Key

5. iOS

5.1 Select the root project and Under Capabilities Enable "Push Notifications".
5.2 Next Enable "Background Modes" and check "Remote notifications".

6. Windows Phone 8.1 (WP8.1)

Your app does not have to be published however, you must have it created on the Windows Dev Center. Follow our Windows Phone Project SID & Secret setup if you have not done this yet.

6.1 Run cordova build windows and open the .sln in <project-root>/platforms/windows/

6.2 Under the Windows Phone 8.1 project double click on Package.appxmanifest then select the "Application" tab and scroll down to the "Notifications:" section. Change "Toast capable:" to Yes.

6.3 Right click on your VS project and select Store>Associate App with the Store...

6.4 Click Next and sign into your Microsoft account.

6.5 Select your app and press Next.

6.6. Lastly press Associate.


Troubleshooting

If you run into any errors see Troubleshooting Cordova Variants, our our general Troubleshooting section.

Push Notification Testing Requirements

  • iOS - Must test on a real device, Simulator does not support Apple push notifications.
  • Android
    • You MUST build and install your app's APK.
    • You may use an emulator but it must have an updated version of Google Play services installed.

SDK API

Check out our Cordova SDK for more OneSignal functions.

Cordova SDK Setup

OneSignal Cordova SDK Setup Guide. Works with iOS, Android (and derivatives like Amazon) and Windows Phone 8.1.

For Developers