MessagePipe Developer Documentation
MessagePipe is an email, messaging and push notification template engine that allows sending of templated messages through multiple providers.
Overview
- Template Management: Create and manage HTML email templates, message templates and push notification templates with variable injection
- Multi-Provider Support: Configure multiple email providers (SendGrid, Mailgun, Amazon SES, SMTP), message providers (Twilio, Termii, Amazon SNS, Infobip, WhatsApp, Telegram, Signal) and push notification providers (FCM)
- Automatic Failover: If one provider fails, MessagePipe automatically tries the next configured provider
- Project Organization: Organize your templates and configurations by projects
- Bulk Messaging: Send messages to multiple recipients
- Delivery Tracking: Monitor message delivery status and analytics
Key Features
Email
- HTML template creation and management
- Variable injection with preview functionality
- Multiple email provider support with priority-based failover
- Bulk email sending
- Delivery tracking and analytics
- Template import/export between projects
- Email retry for failed deliveries
Messages
- Message template creation and management (for SMS, WhatsApp, Telegram, Signal)
- Variable injection for personalized messages
- Multiple message provider support with priority-based failover
- Preferred provider selection per send request
- Bulk message sending
- Template import/export between projects
Push Notifications
- Push notification template creation and management
- Variable injection for personalized notifications
- Device token registration and management
- Single and bulk push notification sending
- FCM support for Android, iOS and Web
Project Management
- Multi-project support
- Team member collaboration with role-based access
- API key management per project
- Invite management (send, resend, cancel invites)
Supported Providers
Email Providers
- SendGrid: A popular email service with robust delivery
- Mailgun: A developer-friendly email API
- Amazon SES: AWS email service
- SMTP: Custom SMTP server support
Message Providers
SMS
- MessagePipe: MessagePipe's built-in SMS gateway (zero configuration)
- Twilio: A leading SMS and communication platform
- Termii: An African-focused SMS service
- Amazon SNS: AWS SMS service
- Infobip: Global communications platform
Apps (Messaging Apps)
- WhatsApp: Via Meta's official WhatsApp Business API
- WhatsApp (Twilio): WhatsApp delivery through Twilio
- Telegram: Via Telegram Bot API
- Signal: Via self-hosted Signal CLI
Push Notification Providers
- FCM (Firebase Cloud Messaging): Google Firebase push notifications for Android, iOS and Web
Getting Started
- Set up authentication and get your API key
- Create your first template
- Configure providers for message delivery
- Send your first message
- Set up push notifications
Architecture
MessagePipe uses a priority-based failover system where providers are attempted in order of priority (lower numbers = higher priority). If a provider fails, the system automatically tries the next available provider, ensuring reliable message delivery.
When sending messages, you can also specify a preferredProvider to route a particular send request through a specific provider, overriding the default priority order.
Templates support variable injection using the Handlebars templating engine which allows you to access personalized messaging at scale.