@pusher/push-notifications-server

NodeJS Server SDK for Pusher Push Notifications

Stats

StarsIssuesVersionUpdatedCreatedSize
@pusher/push-notifications-server
1521.2.45 months ago4 years agoMinified + gzip package size for @pusher/push-notifications-server in KB

Readme

Build npm npm

Pusher Beams Node.js Server SDK

Full documentation for this SDK can be found here

Installation

The Beams Node.js server SDK is available on npm here.

You can install this SDK by using npm:

$ npm install @pusher/push-notifications-server --save

Or yarn if you prefer:

$ yarn add @pusher/push-notifications-server

Usage

Configuring the SDK for Your Instance

Use your instance id and secret (you can get these from the dashboard) to create a Beams PushNotifications instance:

const PushNotifications = require('@pusher/push-notifications-server');

let pushNotifications = new PushNotifications({
  instanceId: 'YOUR_INSTANCE_ID_HERE',
  secretKey: 'YOUR_SECRET_KEY_HERE'
});

Publishing a Notification

Once you have created your Beams PushNotifications instance, you can immediately publish a push notification to your devices, using Device Interests:

pushNotifications.publishToInterests(['hello'], {
  apns: {
    aps: {
      alert: 'Hello!'
    }
  },
  fcm: {
    notification: {
      title: 'Hello',
      body: 'Hello, world!'
    }
  }
}).then((publishResponse) => {
  console.log('Just published:', publishResponse.publishId);
}).catch((error) => {
  console.log('Error:', error);
});

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.