Documentation

Start with the project overview, then choose the task you need.

Get started

First signed webhook: run the local stack and inspect delivery.
Webhooks to queues: RabbitMQ walkthrough and Kafka/SQS alternatives.
Run locally: disposable dev stack, persistent production-style setup, signed requests and a failure/retry walkthrough.
Examples: runnable YAML grouped by feature.
Docker images: core, replay and frontend images.
Contributing: development setup and checks.

Configuration: YAML fields, defaults and destinations.
CLI: commands, flags, environment variables and exit codes.
Security: signatures, credentials and network access. Report vulnerabilities through SECURITY.md.
Ingress adapters: routing, credentials, HTTP relays, SQS/SNS formats, batches and file handling.
MCP gateway: configurable endpoints, tools and OAuth configuration, including identity-provider setup and per-tool permissions.
OpenAPI importer: generate MCP tools from explicitly selected API operations.
Sentry to Discord: signed issue alerts, setup and a local fixture.
Provider recipes: GitHub, Stripe, Paddle and Slack.
Named events: shared payload contracts and event construction before delivery.
Validate JSON: schemas, conversions and sample checks.
Lookups: HTTP, PostgreSQL and DynamoDB routing values.
Feature flags: LaunchDarkly evaluation, fallbacks, typed routing and replay compatibility.
Rate limits and duplicate protection: stores, quotas, expiry and policy changes.

Delivery guarantees: what a success response means, fan-out and duplicate handling.
Replay service: setup, API, retention and maintenance.
Replay console: inspect payloads/files and recover failures; view-only inspections let you spot-check webhooks.
Uncertain delivery: check the destination before confirming or repeating an unknown outcome.
Monitoring and incidents: dashboards, alerts and troubleshooting.
Resource sizing: body, memory, queue and time limits.
Upgrades and rollback: coordinated shutdown and migrations.
Backup and restore: recover data without repeating delivered work.
Releases: manual publication and image verification.

Extending Hookway: module layout, generated contracts, node/API changes and UI conventions.
Pipeline invariants: ordering and delivery rules.
Performance: dated ingress, replay and protection measurements.

API specifications: editor OpenAPI and replay OpenAPI. Regenerate them using the contributor instructions.

Durable MCP event subscriptions: authenticated subscriptions and signed callbacks.