# Herald

> Documentation for Herald, version 1.x.
> Every entry links to the page's markdown source.

Repository: https://github.com/xraph/herald
Site: https://www.xraph.com/docs/herald

## Pages

- [Go Package Reference](https://www.xraph.com/docs/herald/api-reference/go-packages.md): Complete Go package index for Herald.
- [HTTP API](https://www.xraph.com/docs/herald/api-reference/http-api.md): Complete HTTP API reference for Herald notification endpoints.
- [Architecture](https://www.xraph.com/docs/herald/architecture.md): How Herald's packages fit together and how the delivery pipeline works.
- [Configuration](https://www.xraph.com/docs/herald/concepts/configuration.md): Configuring a Herald instance and the Forge extension.
- [Entities](https://www.xraph.com/docs/herald/concepts/entities.md): Core data types used across Herald's notification subsystems.
- [Error Handling](https://www.xraph.com/docs/herald/concepts/errors.md): Sentinel errors and error patterns used across Herald.
- [Identity (TypeID)](https://www.xraph.com/docs/herald/concepts/identity.md): How Herald uses prefix-qualified, globally unique identifiers for every entity.
- [Multi-Tenancy](https://www.xraph.com/docs/herald/concepts/multi-tenancy.md): App-scoped data isolation and scoped provider resolution in Herald.
- [Getting Started](https://www.xraph.com/docs/herald/getting-started.md): Install Herald and send your first notification in under five minutes.
- [Custom Store](https://www.xraph.com/docs/herald/guides/custom-store.md): Implementing the composite store.Store interface for a custom Herald backend.
- [Forge Extension](https://www.xraph.com/docs/herald/guides/forge-extension.md): Using Herald as a Forge extension with YAML config, auto-registration, and lifecycle integration.
- [Full Example](https://www.xraph.com/docs/herald/guides/full-example.md): Complete working example covering store setup, provider creation, template rendering, and notification delivery.
- [Multi-Tenant Patterns](https://www.xraph.com/docs/herald/guides/multi-tenant-patterns.md): Per-org email providers, per-user locale preferences, and scope resolution patterns.
- [Introduction](https://www.xraph.com/docs/herald.md): Unified multi-channel notification delivery engine for Go.
- [Grove ORM Integration](https://www.xraph.com/docs/herald/stores/grove.md): How Herald uses Grove as its ORM layer across all database backends.
- [Memory Store](https://www.xraph.com/docs/herald/stores/memory.md): In-memory store for development and testing with no persistence.
- [MongoDB Store](https://www.xraph.com/docs/herald/stores/mongo.md): Document-oriented MongoDB backend using Grove ORM with mongodriver.
- [PostgreSQL Store](https://www.xraph.com/docs/herald/stores/postgres.md): Production-ready PostgreSQL backend using Grove ORM with pgdriver.
- [SQLite Store](https://www.xraph.com/docs/herald/stores/sqlite.md): Lightweight SQLite backend using Grove ORM with sqlitedriver.
- [Delivery Pipeline](https://www.xraph.com/docs/herald/subsystems/delivery.md): Understand Herald's notification delivery pipeline including Send, Notify, message lifecycle, and provider resolution.
- [Drivers](https://www.xraph.com/docs/herald/subsystems/drivers.md): Built-in notification drivers for SMTP, Resend, Twilio, FCM, and InApp delivery with the Driver interface.
- [Inbox](https://www.xraph.com/docs/herald/subsystems/inbox.md): Manage in-app notifications with read/unread tracking, pagination, metadata, and action URLs.
- [Observability](https://www.xraph.com/docs/herald/subsystems/observability.md): Monitor Herald with structured logging via slog, the message delivery log, and the event hook system.
- [Preferences](https://www.xraph.com/docs/herald/subsystems/preferences.md): Manage per-user notification preferences with per-type per-channel opt-in/opt-out controls.
- [Providers](https://www.xraph.com/docs/herald/subsystems/providers.md): Configure notification delivery providers with driver credentials, channel types, and priority-based selection.
- [Scoped Configuration](https://www.xraph.com/docs/herald/subsystems/scoped-config.md): Configure per-scope provider overrides, sender info, and default locale through Herald's resolution chain.
- [Templates](https://www.xraph.com/docs/herald/subsystems/templates.md): Manage notification templates with slug-based lookup, i18n versioning, variable definitions, and Go template rendering.