# Relay

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

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

## Pages

- [Go Packages](https://www.xraph.com/docs/relay/api-reference/go-packages.md): Quick reference for all Relay Go packages and their public APIs.
- [HTTP Admin API](https://www.xraph.com/docs/relay/api-reference/http-api.md): Complete reference for the Relay admin API endpoints.
- [Architecture](https://www.xraph.com/docs/relay/architecture.md): How Relay's packages fit together.
- [Configuration](https://www.xraph.com/docs/relay/concepts/configuration.md): Functional options, the Config struct, and how to customize Relay behavior.
- [Entities](https://www.xraph.com/docs/relay/concepts/entities.md): The base entity type and how domain objects are structured in Relay.
- [Error Handling](https://www.xraph.com/docs/relay/concepts/errors.md): Sentinel errors and how Relay surfaces problems.
- [Identity (TypeID)](https://www.xraph.com/docs/relay/concepts/identity.md): How Relay uses prefix-qualified, globally unique identifiers for every entity.
- [Multi-Tenancy](https://www.xraph.com/docs/relay/concepts/multi-tenancy.md): How Relay isolates tenants and scopes every operation.
- [Getting Started](https://www.xraph.com/docs/relay/getting-started.md): Install Relay and send your first webhook in under five minutes.
- [Custom Store](https://www.xraph.com/docs/relay/guides/custom-store.md): Implement your own store backend.
- [Forge Extension](https://www.xraph.com/docs/relay/guides/forge-extension.md): Mount Relay into a Forge application.
- [Full Example](https://www.xraph.com/docs/relay/guides/full-example.md): Build a complete webhook server with Relay.
- [Webhook Verification](https://www.xraph.com/docs/relay/guides/webhook-verification.md): How to verify webhook signatures on the receiving end.
- [Introduction](https://www.xraph.com/docs/relay.md): Composable webhook delivery engine for Go.
- [Grove Integration](https://www.xraph.com/docs/relay/stores/grove.md): How Relay stores use Grove ORM and Grove KV for database access.
- [Memory Store](https://www.xraph.com/docs/relay/stores/memory.md): In-memory store for development, testing, and prototyping.
- [MongoDB Store](https://www.xraph.com/docs/relay/stores/mongo.md): MongoDB store for document-oriented deployments.
- [PostgreSQL Store](https://www.xraph.com/docs/relay/stores/postgres.md): Production-ready PostgreSQL store using Grove ORM.
- [Redis Store](https://www.xraph.com/docs/relay/stores/redis.md): Redis store for high-throughput, low-latency deployments.
- [SQLite Store](https://www.xraph.com/docs/relay/stores/sqlite.md): Embedded SQLite store for single-process and edge deployments.
- [Admin API](https://www.xraph.com/docs/relay/subsystems/admin-api.md): HTTP admin API for managing webhooks.
- [Catalog](https://www.xraph.com/docs/relay/subsystems/catalog.md): Event type registration, glob matching, and JSON Schema validation.
- [Delivery](https://www.xraph.com/docs/relay/subsystems/delivery.md): The delivery engine, workers, retry schedule, and decision matrix.
- [Dead Letter Queue](https://www.xraph.com/docs/relay/subsystems/dlq.md): Failed delivery management, replay, and bulk operations.
- [Endpoints](https://www.xraph.com/docs/relay/subsystems/endpoints.md): Webhook endpoint management, subscriptions, and secret rotation.
- [Events](https://www.xraph.com/docs/relay/subsystems/events.md): Event submission, idempotency, and the validation pipeline.
- [Observability](https://www.xraph.com/docs/relay/subsystems/observability.md): Prometheus metrics and OpenTelemetry tracing.
- [Rate Limiting](https://www.xraph.com/docs/relay/subsystems/rate-limiting.md): Per-endpoint token bucket rate limiting.
- [Signatures](https://www.xraph.com/docs/relay/subsystems/signatures.md): HMAC-SHA256 webhook signing and verification.