Documentation
Everything you need to run Herald in production
The docs ship alongside the code, so every link below tracks the latest release. Start with the quickstart, then dig into protocol and reference when you need the details.
Get started
Run Herald locally, provision your first tenant, and send an event — the short path.
Architecture
Understand how frames, persistence, fanout, and auth fit together before you wire Herald into production.
Configuration and API reference
Every env var, every endpoint, every WebSocket frame — with request and response shapes you can paste into code.
OpenAPI spec
Generate your own client or plug into API tools. The same spec powers all six official admin SDKs.
SDKs
Pick your language — browser TypeScript for real-time, plus admin SDKs for TS, Go, Python, Ruby, PHP, and C#.