OsmoX
OsmoX is a powerful, centralized notification management system that provides a unified API for sending notifications across multiple channels including email, SMS, WhatsApp, push notifications, and voice calls.Quick Start
Get OsmoX running locally in minutes
Architecture
Understand how OsmoX works under the hood
API Reference
Explore the REST and GraphQL APIs
Channels
Configure notification providers
Features
Multi-Channel Support
Send notifications via Email, SMS, WhatsApp, Push, and Voice from a single API
Provider Chains
Configure fallback providers for automatic failover
Queue-Based Processing
Reliable delivery with Bull queues backed by Redis
Webhooks
Real-time delivery status notifications
Test Mode
Safe testing with whitelisted recipients
Management Portal
Angular-based UI for configuration and monitoring
Supported Providers
| Channel | Providers |
|---|---|
| SMTP, Mailgun, AWS SES | |
| SMS | Twilio, Plivo, AWS SNS |
| Twilio, Twilio Business, 360Dialog | |
| Push | AWS SNS |
| Voice | Twilio |
Architecture Overview
OsmoX follows a queue-based architecture for reliable notification delivery:- API Layer - NestJS backend handling REST and GraphQL requests
- Queue System - Bull queues (Redis-backed) for asynchronous processing
- Provider Integration - Modular provider implementations for each channel
- Portal - Angular frontend for management and monitoring
The scheduler component must be running for notifications to be processed. See the Development Setup guide for details.
Getting Started
1
Set up the environment
Follow the Development Setup guide to configure your local environment
2
Configure a provider
Set up at least one notification provider from the Channels section
3
Send your first notification
Use the API Usage Guide to send a test notification