Skip to content

Hookaido Documentation

Webhook ingress queue for DMZ-first systems

Receive once. Process safely. Keep delivery under your control.

Hookaido is a single binary that accepts webhooks at the edge, durably enqueues them, and lets internal workers consume at their own pace through pull or push flows.

Start in 5 minutes Read the DSL reference Choose deployment mode

Use Ctrl + K to open search from any docs page.

Choose Your Path

Run Pull Mode

Use the DMZ default: ingress + queue in DMZ, internal workers dequeue and ack.

Pull API reference

Run Push Mode

Deliver to internal endpoints with retry, backoff, and optional outbound signing.

Delivery reference

Run Exec Mode

Execute local scripts with webhook payload on stdin. No HTTP server needed.

Exec delivery reference

Operate the Queue

Inspect health, DLQ, and backlog trends from the Admin API.

Admin API reference

Integrate with MCP

Expose typed ops tools for AI agents with role-gated read and mutation controls.

MCP integration

How It Works

graph LR
    WP[Webhook Provider] -->|POST| HK[Hookaido DMZ<br>Ingress -> Queue]
    YW[Internal Worker] -->|Pull / Ack| HK
  1. A provider sends an HTTP request to Hookaido ingress.
  2. Hookaido validates auth and routing rules, then durably enqueues before ACK.
  3. Workers consume by Pull API or Hookaido delivers by push with retries.

Core Guides

Guide Use it for
Getting Started First run, quick config, and local validation
Configuration Full Hookaidofile blocks, defaults, and placeholders
Deployment Modes dmz-queue pull, push mode, and shared listener behavior
Ingress Matching, auth, and rate limiting
Pull API Dequeue, ack, nack, extend contract
Worker gRPC API Optional gRPC transport for pull workers
Admin API Health, backlog, DLQ, and message mutation endpoints
Delivery Push retries, timeouts, concurrency, and signing
Security Secret refs, TLS/mTLS, replay protection, SSRF policy
Observability Logs, metrics, tracing, and diagnostics
Adaptive Backpressure Tuning Production threshold tuning profiles and decision matrix
Performance Baselines Reproducible Pull benchmark workflow and benchstat comparison
Management Model Application and endpoint mapping semantics
MCP Integration Tooling model, roles, and runtime controls
Docs Platform Decision Why docs currently stay on MkDocs Material
OpenSSF Best Practices Badge maintenance notes (portal page is status SoT)