Product Compare Pricing Docs Domain Check Dashboard

Free engine ↗

Start Tier 1 — $199/mo

Documentation

Everything you need to run WarmHawk.

WarmHawk is self-hosted — your own containers, your own nginx, your own TLS certificate, your own Postgres. That means most of what goes wrong is something you can see and fix on your own server in a few minutes, without waiting on a support queue.

This page indexes all of WarmHawk’s documentation: getting started, guides for day-to-day operation (mailboxes, leads, campaigns, sending safety, replies), self-hosting (architecture, backups, TLS/observability), the full API reference, and a reference section (guardrails, FAQ & changelog) — plus an operations appendix for install/update/billing troubleshooting. Start with Introduction if you’re new, or jump straight to the page that answers what you’re stuck on.

On Tier 1 or Tier 2? You never touch any of this — skip straight to what the operator dashboard includes. Everything below is the underlying API, for Tier 0 self-hosters and developers.

Get started

What WarmHawk is, what actually ships today, and the three tiers in one page.

Quickstart & installation

Install the stack and send a real test email in six curl calls against the real /v1 API.

Guides

Connecting mailboxes

Register a domain, then connect a mailbox via SMTP/IMAP or Google/Microsoft OAuth.

Leads & enrichment

Single create, CSV bulk import, unauthenticated webhook ingest, GDPR erasure, and the Clay/Apollo recipe.

Campaigns, AI & content quality

Spintax vs BYOK AI personalization, the content-quality score, and the launch/pause lifecycle.

Sending safely & domain health

The send queue’s cadence floor and jitter, the bounce circuit breaker, and domain health checks.

IMAP reply polling and AI classification, automatic opt-out suppression, and Tier 1/2 team access.

Self-hosting

Tier 0

Every docker compose service, the internal-only network boundary, logs, and resource limits.

Backups & Redis durability

Nightly Postgres backups and the full restore procedure, plus why Redis runs AOF-durable.

TLS & observability

Certbot issuance/renewal that fails safe, BYO-cert, bundled Uptime Kuma, and native OTEL export.

API reference

Tier 0

Auth & mailboxes

POST /v1/auth/login and the full mailbox CRUD + OAuth-connect routes.

Leads & campaigns

Every lead-ingest route and the full campaign lifecycle, field by field.

Queue, domains & webhooks

Queue status/pause, domain health checks — and an honest “Planned” notice for outbound webhooks.

OpenAPI spec (openapi.json)

Machine-readable OpenAPI 3.0.3 description of every route documented above, for coding agents and API clients — not a substitute for the prose reference, a companion to it.

/openapi.json →

Reference

Guardrails & compliance

CAN-SPAM, RFC 8058, EU AI Act disclosure, GDPR erasure, the bounce circuit breaker, and rate limits.

FAQ & changelog

Common orientation questions, plus what’s actually shipped in each repo so far.

Operations appendix

Real troubleshooting content that doesn’t fit the sections above — still fully documented and linked, just not part of the core 15-page structure.

install.sh troubleshooting

Docker missing, ports already bound, DNS not propagated yet, and safe re-runs.

warmhawk update failures

What warmhawk update does, a stuck migration, and rolling back a bad update.

License activation troubleshooting

“License invalid”/“expired” errors, LicenseGate’s daily re-check, and paid-but-unlicensed.

Stripe checkout & webhooks

What the checkout webhook does, a missing install-command email, and the Customer Portal.