A Node.js library to send all kinds of transactional notifications.

*New: we created a Slack for support and discuss new features.

Features

• Easy channel integration — Want to start sending emails | SMS | pushes | webpushes? Do so in no time!

• Unique documentation — Don't look everywhere for the parameters you need to pass, just do it once. Switching provider becomes a no-brainer.

• Multiple providers strategies — Want to use more than one provider? Use fallback and round-robin strategies out of the box.

• Tools for local testing — Run a catcher locally to intercept all your notifications and display them in a web interface.

• MIT license — Use it like you want.

Getting Started

$ yarn add notifme-sdk

import NotifmeSdk from 'notifme-sdk'

const notifmeSdk = new NotifmeSdk({}) // empty config = all providers are set to console.log
notifmeSdk
  .send({sms: {from: '+15000000000', to: '+15000000001', text: 'Hello, how are you?'}})
  .then(console.log)

Congratulations, you should see the following lines in your console:

[Recommended] Setup Notification Catcher for your local tests

Notification Catcher is a web interface for viewing and testing notifications during development.

$ yarn add --dev notification-catcher
$ yarn run notification-catcher

import NotifmeSdk from 'notifme-sdk'

const notifmeSdk = new NotifmeSdk({
  useNotificationCatcher: true // <= this sends all your notifications to the catcher running on port 1025
})
notifmeSdk
  .send({sms: {from: '+15000000000', to: '+15000000001', text: 'Hello, how are you?'}})
  .then(console.log)

Open http://localhost:1080 on your favorite browser, you should see the notification:

See complete documentation on GitHub