teleflow
v0.1.1
Published
On-Boarding Cli
Downloads
16
Readme


⭐️ 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 multichannel communication experience over email, sms, push, chat and more... An ever-growing list of providers are popping up each day, and notifications are spread around the code. Teleflow's goal is to simplify notifications and provide developers the tools to create meaningful communication between the system and its users.
✨ Features
- 🌈 Single API for all messaging providers (Email, SMS, Push, Chat)
- 💅 Easily manage notification over multiple channels
- 🚀 Equipped with a CMS for advanced layouts and design management
- 🛡 Built-in protection for missing variables (Coming Soon)
- 📦 Easy to set up and integrate
- 🛡 Debug and analyze multichannel messages in a single dashboard
- 📦 Embeddable notification center with real-time updates
- 👨💻 Community driven
🚀 Getting Started
We are excited to launch the complete Teleflow API and admin panel. Want to give it a test before the official release? here is how:
npx teleflow initAfter setting up your account using the cloud or docker version you can trigger the API using the @teleflow/node package.
npm install @teleflow/nodeimport { Teleflow } from '@teleflow/node';
const teleflow = new Teleflow(process.env.TELEFLOW_API_KEY);
await teleflow.trigger('<TRIGGER_NAME>', {
to: {
subscriberId: '<UNIQUE_IDENTIFIER>',
email: '[email protected]',
firstName: 'John',
lastName: 'Doe',
},
payload: {
name: 'Hello World',
organization: {
logo: 'https://happycorp.com/logo.png',
}
},
});Embeddable notification center
Using the Teleflow API and admin panel you can easily add real-time notification center to your web-app without the hassle of building it yourself. You can use our React component or an iframe embed if you are not using React.
Read more about how to add a notification center to your app with the Teleflow API here
Providers
Teleflow provides a single API to manage providers across multiple channels with a simple-to-use interface.
- [x] Sendgrid
- [x] Netcore
- [x] Mailgun
- [x] SES
- [x] Postmark
- [x] NodeMailer
- [x] Mailjet
- [x] Mandrill
- [x] SendinBlue
- [x] EmailJS
- [ ] SparkPost
📞 SMS
- [x] Twilio
- [x] Plivo
- [x] SNS
- [x] Nexmo - Vonage
- [x] Sms77
- [x] Telnyx
- [x] Termii
- [x] Gupshup
- [ ] Bandwidth
- [ ] RingCentral
📱 Push
👇 Chat
📱 In-App
- [x] Teleflow
- [ ] MagicBell
Other (Coming Soon...)
- [ ] PagerDuty
💻 Need Help?
We are more than happy to help you. Don't worry if you are getting some errors or problems while working with the project. Or just want to discuss something related to the project.
Just Join Our Discord server and ask for help.
