/notifire

๐Ÿš€ Open-source notification infrastructure for products

Primary LanguageTypeScriptMIT LicenseMIT

Read here our plans for the upcoming weeks.

Notification management simplified.

The ultimate library for managing multi-channel notifications with a single API.


Explore the docs ยป

Report Bug ยท Request Feature ยท Read our blog

โญ๏ธ Why

Building a notification system is hard, at first it seems like just sending an email but in reality it's just the beginning. In today's world users expect multi channel communication experience over email, sms, push, direct and more... An ever growing list of providers are popping up each day, and notifications are spread around the code. Notifire's goal is to simplify notifications and provide developers the tools to create meaningful communication between the system and it's users.

โœจ Features

  • ๐ŸŒˆ Single API for all messaging providers (Email, SMS, Push, Direct)
  • ๐Ÿ’… Easily manage notification over multiple channels
  • ๐Ÿš€ Equipped with a templating engine for advanced layouts and designs
  • ๐Ÿ›ก Built-in protection for missing variables
  • ๐Ÿ“ฆ Easy to set up and integrate
  • ๐Ÿ›ก Written in TypeScript with predictable static types.
  • ๐Ÿ‘จโ€๐Ÿ’ป Community driven

๐Ÿ“ฆ Install

npm install @notifire/core
yarn add @notifire/core

๐Ÿ”จ Usage

import { Notifire, ChannelTypeEnum } from '@notifire/core';
import { SendgridEmailProvider } from '@notifire/sendgrid';

const notifire = new Notifire();

await notifire.registerProvider(
  new SendgridEmailProvider({
    apiKey: process.env.SENDGRID_API_KEY,
    from: 'sender@mail.com'
  })
);

const passwordResetTemplate = await notifire.registerTemplate({
  id: 'password-reset',
  messages: [
    {
      subject: `You password reset request`,
      // Or for translation or custom logic you can use function syntax
      // subject: (payload: ITriggerPayload) => getTranslation('resetPasswordSubject', payload.language),
      channel: ChannelTypeEnum.EMAIL,
      template: `
          Hi {{firstName}}!
          
          To reset your password click <a href="{{resetLink}}">here.</a>
          
          {{#if organization}}
            <img src="{{organization.logo}}" />
          {{/if}}
      `
    },
  ]
});

await notifire.trigger('<REPLACE_WITH_EVENT_NAME>', {
  $user_id: "<USER IDENTIFIER>",
  $email: "test@email.com",
  firstName: "John",
  lastName: "Doe",
  language: "en",
  organization: {
    logo: 'https://evilcorp.com/logo.png'
  }
});

Providers

Notifire provides a single API to manage providers across multiple channels with a single to use interface.

๐Ÿ’Œ Email

๐Ÿ“ž SMS

๐Ÿ“ฑ Push (Coming Soon...)

  • Pushwoosh
  • SNS

๐Ÿ‘‡ Direct (Coming Soon...)

  • Slack
  • MS Teams
  • Discord
  • Mattermost

๐Ÿ“ฑ In-App (Coming Soon...)

  • Notifire
  • MagicBell

Other (Coming Soon...)

  • PagerDuty

๐Ÿ”— Links