The REST API.
Everything the SDK does is plain HTTPS and JSON under /v1. Authenticate with a Bearer API key; the key fixes the project and environment.
What you get
Resources
Messages and their events, templates and versions, tenants, connections, senders and grants, webhooks and deliveries, usage, stats and contact erasure.
Idempotency
Send an Idempotency-Key header. The same key and body return the original result for 24 hours; a different body returns idempotency_conflict.
Cursor pagination
Lists take limit, up to 100, and starting_after, and return has_more.
Problem details
Errors follow RFC 9457 with a stable code and a request_id.
Scoped keys
Keys carry permissions such as messages.send, read, templates.manage, developer.manage and connections.manage, and can be limited to tenants. Recipient numbers stay masked without pii.read.
Rate limits
Limits per key return 429 with Retry-After.
Batch API and API explorer
At launchBatch sends with per-item results, and an in-browser explorer that runs against Sandbox.
CLI and MCP
Release 2Administer Hopwire from the command line and AI assistants.
Questions
Is the API described by OpenAPI?
Yes. The API is described by an OpenAPI 3.1 specification generated from the code.
What does a send return?
202 Accepted with the message. The status starts as accepted; delivery follows by webhook.
How do I name the tenant?
Pass tenant with its ID or your external reference. A key limited to one tenant can leave it out.
Can I retry a 500?
Yes, with the same Idempotency-Key. Quote the request_id if it persists.
Related
- SDKAvailableA typed server-side SDK for Node with automatic idempotency keys, careful retries, typed errors and a webhook verifier.
- Error codesAvailableStable request error codes and delivery outcome codes, each with a cause, a fix, and whether it retries or falls back.
- Developer overviewAvailableHow Hopwire fits into your backend: a REST API, a TypeScript SDK, signed webhooks and a sandbox with fixed failure scenarios.
Start with the beta.
Hopwire is free during the invite-only beta. Tell us what you send and we will reply by email.