So you have a sweet Ionic app ready, but want to be able to push notifications to your users. The guys over at Drifty feel you and setup Ionic Push just for you!
While the documentation is well done, there is a lot there and personally, I feel like it’s out of order. In this article we’ll cover some steps to get setup quickly for an Android device.
Please note that this article assumes you already have an Ionic application and testing should be done on a real device. It is possible to test notifications in a browser with Ionic’s develop mode, but that’s beyond the scope of this article.
The information flows like this:
Your Server -> Ionic’s Server -> GCM (Google) -> Device
Simple, right? Right. Lets go over the setup steps.
Step 1: Setup Accounts
You’ll need both an Ionic account and a Google account to use the push notifications. They both require a little bit of configuration as well.
First, create an ionic account here.
Once your account is created, go to your Ionic application directory in a
console and type
ionic upload. This will setup your app with Ionic’s server.
This will ask for your new ionic login and push your app to their servers. You should be able to see your app in the Ionic dashboard shortly after.
The app with have an ID and will be needed later.
Click the app name to go into the app and view it’s settings. There is a public key and a private key for your application’s push notifications. These will be needed later as well.
Next, log into the Google Developer’s Console. From the Google Developer’s console, click the Create Project button, choose a name and select Create.
Note the Project ID in the project list. This will be needed later.
Select the project name in the list and then, click the Overview link. Note the Project Number. This is your GCM_ID and will be needed later.
Next, under APIs & auth, click the APIs link. This will show a list of available Google APIs. Choose Cloud Messaging for Android and enable the API.
Then, under APIs & auth, click Credentials and Create new Key under Public
Access API. You’ll want to select
Server as the type of key. Follow the
instructions regarding IP restrictions to your preference and select Create.
Note the API Key that was created. Copy that to your clipboard and go back to
your Ionic app directory and use the command
ionic push --google-api-key api-key
api-key is the key you just copied to your clipboard.
- Create Ionic account here
ionic uploadin app directory
- View app here
- Create Google Project here
- APIs & auth -> APIs -> Cloud Messaging for Android -> Enable API
- APIs & auth -> Credentials -> Create new Key -> Server -> Copy API key
ionic push --google-api-key api-keyin app directory
Step 2: Your Server
Ionic provides a fairly simple RESTful interface to their push server. You make a HTTP POST to a specific URL with special headers and JSON as the body of the request. You also need to set the username of basic authentication to your ionic private key, and nothing for the password.
The URL you POST to is https://push.ionic.io/api/v1/push
The two headers required are: - Content-Type: application/json - X-Ionic-Application-Id: YOUR_APP_ID
Where YOUR_APP_ID is the App ID you get from your Ionic dashboard.
You can get your private key from the dashboard as well, by selecting the settings of your app and viewing the Secret Key.
The POST body will need to be in JSON format like the following:
The tokens are the device tokens you want to send the notification to. The
alert key is what will show up on the notification screen, and the payload
will be accessible from your Ionic application once the user selects the
notification from the drawer.
Gotcha Alert: Take special note of the
$state key. This key is required by
the Ionic push service in the framework. It’s value should be a state you setup
using ui-router in your Ionic application. If it is not present, things will
blow up. The application will load this state when the notification is opened.
Here is a sample snippet of Ruby code for pushing a notification:
Step 3: Your App
The final step is to setup your application to receive the notifications. There are three different states your app can be in when a notification is received. Open and in the foreground, open but backgrounded, or completely closed. It’s important to make sure your app reacts appropriately in all three states so your user can get the best experience out of your hard work.
First you need to install a few extra components in your Ionic app using their
ionic add and
ionic plugin command line functions. From your app’s directory
in a terminal run the following commands:
This will install the phonegap push notification plugin, Ionic’s angular to cordova plugin framework, and Ionic’s core and push services used to make the rest of this a breeze.
Then, open up your
index.html page and add the following libraries to your
Finally, you need to add those services to where you declare your angularjs module. It should look something like this:
Please note that all these examples above were borrowed from Ionic’s documentation.
ionic plugin add https://github.com/phonegap-build/PushPlugin.git
ionic add ngCordova
ionic add ionic-service-core
ionic add ionic-service-push
- Add items to
- Add modules to your angular module
Handling Push Notifications
There are three things your app needs to handle in regards to notifications. It needs to identify itself with Ionic’s server, handle a callback from Ionic to get the device token for that device and handle a callback from Ionic to do something when a notification is received.
Identify Your App with Ionic
config block of your Ionic application, you need to identify your app
with the Ionic servers. You need three things for this. Your Ionic App ID,
your Ionic Public key and your Google GCM ID.
Your Ionic App ID is found on the Ionic dashboard. Selecing the Ionic App name and going to Settings will show you the Ionic Public Key. Going to the Google Developer’s Console and selecting your project and then clicking the Overview link will give you your GCM ID. It’s the Project Number across the top.
config block should look something like this:
Reacting to Notifications
run block of your app, you can register with the push service to react
to notifications being selected by users when the app is in various states.
When a notification comes in it can be of type
registered event comes through, you’ll get your device token from the message.
You should send this information to your server however you’d like. You’ll use this
token to tell Ionic which device to send the notification to.
When the event is
message it will contain the payload you set on the server
side when POSTing the notification to Ionic’s server.
$ionicPush.register is also a promise. In the
then of that promise, fired upon
push registration completion, you need to identify your user with Ionic’s server.
This is pretty straight forward, you just get the user with
and if they don’t already have a user_id field, add one. This field can be anything
you want. I use the device’s uuid in the example below which can be used for
anonymous users with Ionic.
Once you set the user id you call
$ionicUser.identify(user) to set that user up
with Ionic and you’re ready to go!
Here is a snippet of what a push registration would look like:
- Identify keys and IDs with
- Register for push notifications with
- Identify user with
- Handle notification states in
There are quite a few pieces to this puzzle, but once you get the idea of how the data is flowing, it’s a bit easier to understand what each of these pieces are doing and why they are needed. Now, go notify your users!