WarmHawk
Docs / Reference / FAQ & changelog

Questions worth answering up front, and what actually shipped.

WarmHawk is self-hosted, so most of what goes wrong is something you can see and fix on your own server in a few minutes. This page rounds up the questions that come up before someone even starts, and what each of the three repos has actually shipped so far.

This page answers the most common orientation questions about WarmHawk’s docs and API, then summarizes what each repo has shipped. The engine (v1.9.1) and the dashboard (v1.18.0) ship tagged semver releases; this site deploys continuously without version numbers. Every version and date below is a real release.

Questions

Questions worth answering up front

Where do I start if I’ve never used WarmHawk’s API before?+

Quickstart & installation. It walks through installing the stack and a real send in six curl calls, start to finish, in about 5 minutes.

My install.sh run failed — where do I look first?+

install.sh troubleshooting covers the three most common causes: Docker/Compose missing, ports 80/443 already bound, and DNS that hasn’t propagated yet. Most failures are one of those three.

Is there a full API reference?+

Yes — API reference documents the real, current shape of every /v1 route across three pages (Auth & mailboxes, Leads & campaigns, Queue/domains/webhooks), field by field, matching what’s actually shipped in warmhawk-core-engine today.

Where’s the product changelog?+

Below on this page. warmhawk-core-engine and the licensed dashboard ship tagged, semver releases, and this page summarizes the latest of each. warmhawk-core-engine is source-available (BSL 1.1), so its CHANGELOG.md links through; the dashboard and this site are proprietary, so the summaries here are the changelog for those two.

Are there outbound webhooks I can register for events?+

Not yet — see the Planned notice on the Queue, domains & webhooks API reference page. Poll the relevant GET route instead until that ships.

Changelog

This site doesn’t own the product changelog. Each package ships and maintains its own CHANGELOG.md, versioned alongside its code, summarized here. warmhawk-core-engine is source-available (BSL 1.1) and its file links through; the licensed dashboard and this site are proprietary, so their summaries below are the changelog. Each card shows the newest release and its headline changes.

warmhawk-core-engine

v1.9.1 · Oct 4, 2026

The sending/queueing API, worker, and install.sh. Tagged semver releases since v1.0.0; warmhawk update moves an install to the newest one.

  • v1.9.1: deleting a mailbox ends the follow-up sequences of the leads it was sending to, and install and update retry listing the n8n workflows before skipping their import.
  • v1.9.0: a mailing address per sending domain, each campaign picks the mailboxes it sends from, and follow-up sequences (up to three, same mailbox, same thread). Launch returns every problem at once; GET /v1/campaigns/:id/launch-check runs the same check without launching. PATCH /v1/campaigns/:id now refuses status, and PUT /v1/instance-settings returns 410.
  • v1.8.0: a built-in unsubscribe page for campaigns with no unsubscribe link of their own.
  • v1.5.0: WarmHawk Connect, one-click Google and Microsoft mailbox connect.
  • v1.3.0: the warm-up engine, with placement checks and test inboxes.
  • v1.0.0: Fastify API + BullMQ worker, cadence/jitter math, Redis AOF durability + crash recovery, CSV import, BYOK AI personalization, reply management, every structural guardrail, and the bundled nginx/certbot/Uptime Kuma/OTEL stack.

warmhawk-enterprise-operator

Source not publicv1.18.0 · Oct 4, 2026

The licensed Tier 1/2 operator dashboard. Tagged semver releases; its update banner compares your version against the newest one.

  • v1.18.0: agency client filter, search and pagination; tables grow with the page; the Compliance settings page is gone, since mailing addresses now live on each domain.
  • v1.17.0: a new campaigns table and 4-step builder (Write, Send from, Leads, Launch check) with follow-ups, an import wizard, a mailing address per domain, a DKIM selector per domain, and a required sender name per mailbox.
  • v1.16.0: the unsubscribe link is optional when the engine serves its own unsubscribe page.
  • v1.0.0: Next.js dashboard with its own Postgres, tier-based feature gating, team invite/remove, TOTP 2FA, an onboarding checklist, and the leads, campaigns, domain health, Unified Reply Inbox and live queue pages.
  • Team invites send over your own SMTP server (any provider — no SDK, no vendor lock-in). With SMTP left unconfigured the invite still works: the dashboard says plainly that nothing was emailed and hands you a copyable accept link to pass along yourself.

warmhawk-site

Source not publicDeployed continuously

This marketing/docs/checkout site. It has no version numbers: each change goes live once it passes review.

  • Homepage, all /vs/* comparison pages, /compare/pricing, /tools/domain-check, /status, /security, /legal/*.
  • Stripe Checkout session, webhook, and Customer Portal routes for Tier 1; sitemap/robots/OG/Twitter/FAQPage schema site-wide.
  • This docs section, restructured into the current 15-page information architecture; a real Tier 2 contact-sales flow and dedicated /checkout route.
  • Docs for the v1.9.0 engine: mailing address per domain, campaign senders and follow-ups, the launch check, and the matching openapi.json.

Before running warmhawk update on a production instance, read the relevant CHANGELOG for breaking changes and new required environment variables — see the pre-update checklist in warmhawk update failures.