Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


 

In order to send push notifications with OneSignal you must have a OneSignal account. The instructions below will instruct you on how to create a OneSignal account, setup Push Notifications for both iOS and Android,  



Anchor
Creating a OneSignal Account
Creating a OneSignal Account

Expand
titleCreating a OneSignal Account


 

  1. Go to onesignal.com. From the OneSignal site, click on Login in the top right-hand corner

    Image Modified

    If you are a returning user, use your existing credentials to login to your OneSignal account. You can create multiple app entries under the same account.

  2. If you need to create a new account click the Sign Up button down the bottom of the pop-up window
    Image RemovedImage Added

  3. Fill in your details and Confirm your account

  4. Once your account has been confirmed you can login to your OneSignal account and begin setting up push notification for iOS and Android.

Anchor
Adding a new app
Adding a new app

 
Expand
titleAdding a new app


  1. Go to OneSignal website

  2. Click Login. If you have a OneSignal account you should login - if not register an account.

    Image Modified

  3. Once logged in - you will be able to Add a New App. Click Add a New App.
    Image Removed
    Image Added

  4. Name your app appropriately and click Create

    Image Modified

  5. You have now created a new app entry to send push notifications to. You can now configure your app for Apple and Android push notifications. You may close the pop-up screen or continue.

 



Expand
titleiOS: Production .p12 creation

Anchor
iOS: Production .p12 creation
iOS: Production .p12 creation

To enable iOS push notifications, you must export your iOS push notifications certificate as a production .P12 file, then upload this file to OneSignal. 


Info

If you haven't already created your iOS push notifications certificate, see the the relevant instructions in iOS Certificates, Identifiers, and Profiles.

You can only modify your push notifications certificate on the Mac computer it was originally created on.

Exporting your Push Notifications Certificate as a .P12

  1. After creating your push notifications certificate and adding it to your Mac computer's Keychain, open the Keychain Access application.

  2. Select the login keychain, and the Certificates category. Identify your push notification certificate.
    The certificate should be identifiable by its name, and the date on which it expires (one year after creation).
    Image Modified

  3.  Hold the control key and click on your push notifications certificate. In the menu that appears, choose to Export your certificate.
    Image Modified

  4. Save the exported certificate as a .P12 file type. This is extremely important, as parse.com will only read .P12 files. As per usual practice, save the .P12 file with an easily identifiable name, in a memorable location.

  5. Next, two dialogue boxes will appear. In the first box, you will be asked to create a password to protect your .P12 file – do not enter a password here.

    Leave both fields blank and click the OK button. Again, this is extremely important as parse.com will not be able to access your certificate if you enable password protection.
    Image Modified
     
  6. The second dialogue box will ask for your computer's system user password. Go ahead and enter your password here, then click Allow to finish exporting your certificate as a .P12.
    Image Modified

    You now have a modified .P12 certificate.

    Next, you will upload this file to OneSignal.
Expand
titleiOS: Setup for OneSignal

Anchor
iOS: Setup for OneSignal
iOS: Setup for OneSignal

  1. Login to OneSignal.com

  2. Select your app entry

  3. Click App Settings along the left-hand tab
    Image Removed
    Image Added

  4. Select Configure for Apple push notification configuration

    Image Modified

  5. You will be taken to a new screen with the option to upload a Sandbox .p12 or a Production .p12. Upload a Production .p12 file. You may ignore the Sandbox .p12 option.
    Image Removed

    Image Added

    If you haven't created a .p12, see the previous step on Creating a Production .p12

  6. Upload the Production .p12 and click Save

  7. Click Continue on the next screen
    Image Removed
    Image Added

  8. The following steps will be regarding Apple SDK which you may click Native iOS and click Next.

  9. The rest of the process can be ignored as all your settings have been configured. You may close the tab.
    Image Removed
    Image Added

  10. Your iOS OneSignal configuration is complete. You may refresh your browser to see the changes applied to your Apple Configuration.

    Image Modified

  11. The next step is to configure your app in Ubiquity (Liquid State Cloud) so you can send Push Notifications. You should keep this tab open in your browser or copy the keys as you will need these for Ubiquity Configuration.
Expand
titleiOS: Ubiquity (Liquid State Cloud) Configuration

Anchor
iOS: Ubiquity (Liquid State Cloud) Configuration
iOS: Ubiquity (Liquid State Cloud) Configuration

  1. Login to your Liquid State account

  2. Click on the app you're going to configure
    Image Removed
    Image Added

  3. Click on Configuration followed by the Apple logo to access configuration for your iOS app.

    Image Modified

  4. Once inside your Apple Configuration, navigate along the side-tab and click Push Notifications
    Image Removed
    Image Added
  5. Select the box Send Push Notifications using OneSignal
    Image Removed
    Image Added

  6. Open OneSignal.com in your browser and log back in

  7. Click on the app entry that you're planning to configure
    Image Modified

  8. Click on App Settings along the left-hand tab

    Image Modified

  9. Click on Keys & IDs after clicking App Settings to access your automatically generated OneSignal App ID and REST API Key

    Image Modified

  10. Copy the OneSignal App ID and paste into the matching section on Ubiquity/Cloud

    Image Modified

    Image Modified

  11. Copy the REST API Key from OneSignal to Ubiquity/Cloud

    Image Modified

    Image Modified

  12. Your configuration is complete for iOS Push Notifications. Hit Save & Continue to finish.

You can now send Push Notifications using OneSignal. If you need to configure Push Notifications for Android, you may continue below.

 



Expand
titleAndroid: Setup & Configuration for OneSignal

Anchor
Android: Setup for OneSignal
Android: Setup for OneSignal

OneSignal also works on Android devices. Make sure you have followed the steps in Creating a OneSignal accountbefore completing the Android configuration.

  1. Login to OneSignal.com

  2. Select your app entry

  3. Click App Settings along the left-hand tab
    Image Removed
    Image Added

  4. Select Configure for Android push notification configuration

    Image Modified

  5. Open Google Services Wizard You will be required to provide Google Server API Key and Google Project Number.

    Image Added

  6. Open Firebase Console to obtain your Google Server API Key . If you have a Google account, sign in. If not, create a Google account by following the prompts.and Google Project Number.

  7. Once signed-in, you will be taken to a screen to begin filling out your app details. Your App Name should match the app name in Ubiquity and OneSignal.
    Image Removed
    Your Android Package Name is a reverse URL that looks something like this: com.android.app. Ubiquity (Liquid State Cloud) will generate an Android Package Name for you. You can obtain this from your account
    Image Removed

  8. Copy and paste this Bundle ID back into Google Services Wizard and click Choose and configure services
    Image Removed
    Google Services Wizard will prompt you to Enable Google Cloud Messaging, click the button and continue
    Image Removed
    In the same window, Google Services Wizard will configure your Cloud Messaging and generate a Server API Key and a Sender ID. Leave this tab open or save the keys on your machine. You have completed all relevant parts of the process on Google Services Wizard.
    Image RemovedOpen your desired project (Application) and click on the settings icon.

  9. Click on Project Settings and then proceed to select Cloud Messaging

    Image Added


  10. Open your Ubiquity (Liquid State Cloud) account and click on your app entry. Click on Configuration > Android > Push Notifications as shown below

    Image Modified

  11. Select Send Push Notifications using OneSignal. This will allow you to send push notifications to your Android app.

    Image Modified

  12. Copy ONLY the and Paste your Google Project Number into the field of Google Sender ID into your account. Leave OneSignal ID and OneSignal REST API Key empty for the time being.

    The Server API Key is used to authenticate your server when sending messages whilst the Sender ID identifies an app that is permitted to send messages to the client app.

    Image Modified


  13. Navigate back to your OneSignal accountand click Configure under App Settings > Android



  14. Copy and paste the Server API Key that you generated in the Google Services Wizard and click Save




  15. Click Continue


  16. Select Android and click Next



  17. OneSignal will generate a unique App ID for your app. Copy this App ID.



  18. Back in Ubiquity, paste your App ID into the OneSignal App ID cell



  19. Back in OneSignal you can cancel the progress of your Android push notifications, all the relevant settings have been configured.



  20. Once you're back in the App Settings screen on OneSignal, click on Keys & IDs



  21. Copy the REST API Key.

    Note: you're OneSignal App ID is also available here for future reference.



  22. Paste the REST API Key into your Ubiquity (Liquid State Cloud) account



  23. Click Save and Continue to complete your Android Push Notification configuration

You have now configured your Push Notifications for Android. View instructions for iOS OneSignal configuration or view How to Send Push Notifications.