notifiee-js v1.0.7

Notifiee

The Notifiee module allows Javascript developers to programmatically send notifications to team members (via multiple channels like Email, SMS, Telegram, Messenger, Slack, and Twitter DMs) through the Notifiee web service. The API is implemented as JSON over HTTP.

Installation

Import the NPM module in your project:

$ npm install notifiee-js
# or
$ yarn notifiee-js

Usage

First configure your API client:

import NotifieeAPI from 'notifiee-js'

const client = new NotifieeAPI({ token: 'YOUR_API_KEY' })

Your API key is associated with a project created within the notifiee.com web interface. To get an API key you will need to sign up.

Once the configuration is set you can send notifications in your code like this:

client.notify('bob', ['telegram'], 'Something happened in our app!')

// or with a subject
client.notify('bob', ['messenger'], 'Something happened in our app!', { subject: 'Our App Notification' })

NOTE: bob is a notifiee that you would have had to have created from within the notifiee.com web interface and configured Telegram and Messenger channels for this notifiee.

License

The package is available as open source under the terms of the MIT License.