This package has been deprecated

Author message:

Roost... RIP

roost-web-push

Roost API for node.js (OFFICIAL)

roost-web-push provides a few functions to integrate Web Push by Roost into any node.js app. Current functions return Roost credentials, send push notifications, and return metrics on previously sent notifications. All you need: Login, Send, Report.

Requirements

You can install roost-web-push and its dependencies with npm: npm install roost-web-push.

• node
• request

You will also need a Roost account. (GoRoost.com - 30-day trials offered.)

Usage

Any call to the Roost API (login is the exception) requires an API Key and Secret. These values can be obtained from the Roost Dashboard or by using the Roost.login() method and sending your Roost User Name and Roost Password.

Login to Roost

var roost = require('roost-web-push');

var user = [YOUR ROOST USER NAME];
var pass = [YOUR ROOST PASSWORD];

roost.login(user, pass, function(data) {
    //DO SOMETHING WITH LOGIN DATA
    console.log(data);
});

The return will be an array of configurations from Roost containing the configuration name, key, and secret. If failed, an error will be returned.

{
    "success":true,
    "userID":123456,
    "apps":[
        {
            "name":"My Site",
            "secret":"1234567890abcdefg",
            "key":"1234567890abcdefg"
        }
    ]
}

Sending a Notification - Basic Send

Notifications consist of a headline of text, and a URL for a landing page. This is the minimum that is required to send a notification.

Message and URL should be passed as an object. (Object.alert and Object.url respectively.)

var roost = require('roost-web-push');

var key = [YOUR ROOST KEY];
var secret = [YOUR ROOST SECRET];

var params = {};

params.alert = "My message to send";
params.url = "http://[URL to landing page][dot]com;

roost.sendNote(key, secret, params, function(data) {
    //DO SOMETHING... Or not here.
    console.log(data);
});

Return will be an array with success / failure and a message, along with notification_id. This ID corresponds to metrics returned with getNotes, and eventually can be used to query metrics on individual notifications. (Look for future releases of this package).

{
    "success":true,
    "message":"Push queued; will be sent to devices within the next few seconds.",
    "notification_id":1234567
}

Sending a Notification - Sending With Parameters

It is possible to target segments of your subscribers, or even individuals, and send scheduled notifications or advanced tests on notification sending. Your plan must support these features and you must first have set these segments or identifiers via our JavaScript API.

Accepted Parameters

Key Name	Description
segments	List of Segments. If included, notification will be sent only to subscribers associated with one or more of the listed Segments.
aliases	List of user Aliases. If included, notification will be sent only to subscribers listed.
device_tokens	List of device tokens on which users registered. If included, notification will be sent only to devices listed.
exclude_tokens	List of device tokens. If included, devices listed will be excluded when the notification is sent.
test_type	Specifies that progressive A/B split-testing will be done to optimize delivery. If included, value must be: 'MULTI_ARM_BANDIT'. In this case, alert must also be specified as an array with a list of alternate titles (EX: ['A Notification Title', 'Alternate Title', 'Third Title']).
schedule_for	Time when the notification will be scheduled for delivery. Format: "YYYY-MM-DDTHH:mm:SSZ". Time is specified in Zulu/GMT. Example: '2015-06-20T08:00:00Z'

var roost = require('roost-web-push');

var key = [YOUR ROOST KEY];
var secret = [YOUR ROOST SECRET];

var params = {};

params.alert = 'Breaking News - Car Crash on the 405';
params.url = 'https://goroost.com';
params.aliases = ['[e-mail]', 'burton@xyz456', '[e-mail]'];
params.device_tokens = ['abcdefg123456789', '987654321gfedcba'];
params.exclude_tokens = ['lmnopqrs789'];
params.schedule_for = '2015-09-05T15:17:00Z';
params.segments = ['Story', 'News', 'Weather'];
params.test_type = 'MULTI_ARM_BANDIT';

roost.sendNote(key, secret, params, function(data) {
    //DO SOMETHING... Or not here.
    console.log(data);
});

Get Notification Metrics

No application is complete without knowing how it is performing. Roost tracks metrics for individual notifications. The roost.getNotes() method returns information on the 10 most recent notifications. (Future versions will support querying for individual notes, allowing count of returned notifications, and offset).

var roost = require('roost-web-push');

var key = [YOUR ROOST KEY];
var secret = [YOUR ROOST SECRET];

var params = {};

roost.getNotes(key, secret, params, function(data) {
    //DO SOMETHING WITH NOTES METRICS
    console.log(data);
});

Return will be an object containing a notifications array including id, sent (date/time), stats.reads, stats.sends, alert, and url.

{
    "notifications":[
        {"
            id":1111111,
            "sent":"2014-10-27T18:11:37Z",
            "stats":
                {
                    "reads":15,
                    "sends":150
                },
            "alert":"Breaking News: Apple Announces new iPhone",
            "url":"http://mysite[dot]com/apple-news"
        },
        {
            "id":2222222,
            "sent":"2014-10-24T20:55:39Z",
            "stats":
                {
                    "reads":23,
                    "sends":153
                },
                "alert":"How to tackle the hard problems",
                "url":"http://mysite[dot]com/something-hard"
        },
        ...
    ]
}

Support / Requests / Feedback

For additional information, support, feedback, or for feature requests, email [e-mail]. We'd like to hear from you.

Future Features

• Add query parameters to the roost.getNotes() method.
• Add general Roost config stats method.
• Provide easy way to include / inject roost.js script onto site