Documentation
Everything you need to integrate the Notification System into your application.
Quick Start Guide
Send your first notification in 5 minutes
API Reference
Complete REST API documentation
SDK Documentation
Official SDKs for JS, Go, PHP, Flutter, Rust, Android, iOS, and Lynx
Channel Guides
Configure Email, SMS, Slack, and more
Quick Start
import { NotificationClient } from '@notification-system/sdk';
const client = new NotificationClient({
apiKey: 'ntf_your_api_key_here',
});
const response = await client.notifications.send({
type: ['email', 'sms'],
content: 'Hello from Notification System!',
target: ['user@example.com', '+1234567890'],
});
console.log('Notification ID:', response.id);Features
Multi-Channel
Send via Email, SMS, Slack, Telegram, WhatsApp
Unified API
Single API for all notification channels
Real-time Tracking
Track opens, clicks, and delivery status
Webhooks
Receive delivery status updates in real-time
Rate Limiting
Built-in rate limiting with configurable quotas
Templates
Reusable message templates with variables
Architecture Overview
Learn more┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ Your App │────▶│ API Gateway │────▶│ Message Queue │
└─────────────────┘ └─────────────────┘ └─────────────────┘
│
┌───────────────────────────────┼───────────────────────────────┐
│ │ │
▼ ▼ ▼
┌───────────────┐ ┌───────────────┐ ┌───────────────┐
│ Email Worker │ │ SMS Worker │ │ Slack Worker │
└───────────────┘ └───────────────┘ └───────────────┘