Read here our plans for the upcoming weeks.
Notification management simplified.
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: 'Your password reset request',
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",
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
๐ฑ In-App (Coming Soon...)
- Notifire
- MagicBell