0.3.6-alpha.0 โข Published 2 years ago
@notifire/core v0.3.6-alpha.0
โจ 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
- Twilio
- Plivo
- SNS
- Nexmo (Vonage)(https://github.com/notifirehq/notifire/tree/master/providers/nexmo)
- Bandwidth
- RingCentral
๐ฑ Push (Coming Soon...)
- Pushwoosh
- SNS
๐ Direct (Coming Soon...)
- Slack
- MS Teams
- Discord
- Mattermost
๐ฑ In-App (Coming Soon...)
- Notifire
- MagicBell
Other (Coming Soon...)
- PagerDuty
๐ Links
0.3.6-alpha.0
2 years ago
0.3.2-alpha.3
2 years ago
0.3.2-alpha.0
2 years ago
0.3.2-alpha.5
2 years ago
0.3.2-alpha.4
2 years ago
0.3.4
2 years ago
0.3.3
2 years ago
0.2.5
3 years ago
0.2.4
3 years ago
0.2.3
3 years ago
0.2.2
3 years ago
0.1.4
3 years ago
0.1.0
3 years ago
0.1.1
3 years ago
0.0.3
3 years ago
0.0.2
3 years ago