The Flowmails SDK
A typed JavaScript client for the Flowmails platform. Send transactional and operational email from your own Cloudflare account — auth via a Bearer SDK key pinned to one of your domains, one outbound endpoint today, reads and webhooks on the way.
Sections
What’s in the SDK today, and what’s next
Each section carries a version badge so you know whether the surface is shipped (v0.1) or on the v0.2 roadmap. The status badges on this page are the single source of truth for what SDK callers can rely on — when a v0.2 feature lands, both the corresponding card here and its target page update in the same PR.
Install & Quick start
Add @flowmails/flowmails-sdk to a Node project and ship your first transactional message in under five minutes.
API endpoints
POST /api/v1/messages request and response shapes, plus the SDK ↔ wire field renames (html → content, base64 attachments).
Errors & retries
The full error matrix, the FlowmailsError class hierarchy, and the retry policy (5xx / 408 / 429 only — never 4xx).
Integrate with AI agents
Install the flowmails-sdk skill into your coding agent and ship a working @flowmails/flowmails-sdk integration in one prompt.
v0.2 roadmap
Reads (messages.list, threads.get) and outbound webhook delivery land in the next milestone. Wire shapes are drafts.
What’s not in v0.1
- Read endpoints (messages.list, threads.get) — use the dashboard inbox in the meantime.
- Outbound webhook delivery on the queued → sent → bounced lifecycle — poll /dashboard/emailbox until v0.2.
- Per-key rate-limit response headers — a 429 is the platform safety floor; client-side backoff is the only mitigation.
Ready to send