Documentation

Dispatch Developer Docs

Integrate multi-channel notifications in your app. Email, SMS, push, WhatsApp, webhooks, and in-app from one API.

Quick Start

quickstart.ts

# Install the SDK
npm install @dispatch/node

# Send your first notification
import { Dispatch } from '@dispatch/node'
const dispatch = new Dispatch('dp_live_...')

await dispatch.send({
  to: 'user_123',
  template: 'welcome',
  channels: ['email', 'sms'],
  data: { name: 'Awa' }
})

Reference

API Reference

REST endpoints, schemas, auth, and error codes.

Guide

Templates

Create and manage notification templates with variables and conditionals.

Guide

Channels

Configure email (Postal), SMS (Pushly), push, WhatsApp, webhooks, and in-app.

Guide

Self-Hosting

Deploy Dispatch with Docker Compose. Includes Postal email engine and Pushly SMS gateway.

Core Concepts

Notification

A single message sent to a user. One notification can be delivered across multiple channels (email + SMS + push) simultaneously.

Template

A reusable notification structure with variables ({{name}}, {{amount}}). Templates support per-channel formatting — the email version can be HTML while SMS is plain text.

Channel

A delivery method: email, SMS, push, WhatsApp, webhook, or in-app. Each channel has its own provider configuration and failover chain.

Provider

The underlying service that delivers on a channel. Email → Postal (self-hosted) or SendGrid (backup). SMS → Pushly or Twilio. Dispatch handles failover automatically.

Tenant

An isolated organization within Dispatch. Each tenant has its own API keys, templates, rate limits, and analytics. Used for multi-org SaaS platforms.