v1 API
Posthawk API Documentation
Everything you need to send, schedule, and manage emails programmatically.
Quick Start
bash
curl -X POST https://your-instance.com/v1/send \
-H "Content-Type: application/json" \
-H "X-API-Key: your_api_key" \
-d '{
"from": "hello@yourdomain.com",
"to": ["user@example.com"],
"subject": "Hello from Posthawk",
"html": "<h1>It works!</h1>"
}'Introduction
Posthawk is an open-source email platform built for developers. Send transactional emails, run newsletters, schedule deliveries, broadcast campaigns, manage templates, and handle inbound email — all through a simple REST API.
Posthawk provides a complete email infrastructure:
- Transactional email sending via AWS SES (multi-region — US East, EU Stockholm)
- Email templates — HTML, React Email, plain text, with variable substitution and required-variable enforcement
- Scheduled email delivery with timezone support, send-now, race-safe cancel/reschedule, and audit log
- Broadcasts — one-off marketing campaigns with cancel mid-send and live progress
- Newsletters — full subscribe / DOI / issues / bulk import / embed widget pipeline with public REST API
- Contacts — workspace-scoped audience with tags, metadata, bulk import, send-by-tag
- Domain management — add, verify, configure sending and inbound receiving programmatically (BYODKIM)
- Webhooks — real-time HMAC-signed notifications for email + newsletter + broadcast events
- Inbound email processing via Cloudflare Email Routing or AWS SNS (dual-region SES)
- SMTP submission relay — send via standard SMTP (port 587) using your API key
- Suppression list — auto-suppress on hard bounce, complaint, or 3 consecutive soft bounces
- Rate limiting, reputation monitoring (SES VDM), and tenant isolation per workspace
- API key management with per-key permission scopes (full access, sending only, reading only)
- Workflow automations — visual workflow builder for trigger-based email flows (Scale plan)
- Cloud-only: AI assistant, audit logs, pay-as-you-go overages, multi-workspace + team roles
Base URL: https://your-posthawk-instance.com
Cloud (managed) users: your base URL is https://api.posthawk.dev