When to Use This Approach
- ✅ You have existing event detection systems
- ✅ You have custom business logic for notifications
- ✅ You prefer to control when and how events are detected
- ✅ Your events are primarily off-chain or custom patterns
- ✅ You want to integrate with existing backend services
Integration Overview
The integration process involves two main steps:- Configure Dialect SDK/API in your backend services
- Send notifications at the point of events in your application
Choose Your Integration Method
Option 1: TypeScript SDK (Recommended)
Best for Node.js/TypeScript backends. Provides type safety and simplified API. Setup & Configuration: Follow our complete SDK Setup & Configuration guide for installation, app registration, and initialization. Send Messages: Use our SDK Send Messages guide for comprehensive examples including:- Single user notifications
- Batch notifications to multiple users
- Channel-specific delivery (email, Telegram, push)
- Interactive notifications with action buttons
- Rich content and formatting
Option 2: REST API
Best for non-JavaScript backends or custom integrations. Setup & Configuration: Follow our complete API Authentication guide for API key setup and request authentication. Send Messages: Use our API Send Messages guide for comprehensive examples including:- Individual and batch messaging
- Channel targeting
- Rich HTML content for emails
- Interactive notifications with actions
Real-World Integration Examples
Realms Governance API- Use case: Powers notifications for post and comment upvotes and replies on Realms Discover
- Implementation: Direct backend integration using Dialect SDK within NestJS architecture
- Features: Event-driven notifications from existing services, custom business logic integration
- Use case: DAO proposal and governance event monitoring
- Implementation: Dialect Monitor integration for automated event detection
- Features: Proposal tracking, voting reminders, and governance event notifications
- Use case: Liquidation warnings for DeFi lending positions
- Implementation: Monitoring service with backend integration patterns
- Features: Threshold-based notifications and risk management alerts
- Use case: Staking protocol notifications and updates
- Implementation: Backend integration with broadcast messaging features
- Features: Multi-user notifications and staking event detection
- Use case: Trading and AMM protocol notifications
- Implementation: Push-type data sources with multi-channel delivery
- Features: Real-time trading alerts and cross-platform integration
- Use case: Investment platform with multiple notification types
- Implementation: Complex backend with various notification triggers
- Features: Portfolio alerts, investment opportunities, and user engagement