Documentation
The CommuniQueue API
The API sends notifications by template id. Email is live today, and webhook delivery is available on plans that include it. SMS is built but switched off platform-wide - no plan can enable it yet. Drafting, testing, and publishing templates happens in the app - the API's job is to trigger a send with whatever version is currently live.
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /api/v1/notifications/send | Queue a notification rendered from a template's live version. |
| POST | /api/v1/notifications/preview | Render a template with your variables without sending anything. |
| GET | /api/v1/api-keys/validate | Check whether a key is valid without sending a notification. |
Where a key comes from
Every request carries an X-Api-Key header. Create one from a workspace's API keys page (/workspaces/{workspaceId}/api-keys) - it is shown once and is scoped to that workspace. See Authentication for the full picture, including where to go create one.
Guides
- Quickstart
Send your first templated email in four steps.
- Integrate with an AI agent
Install the CommuniQueue skill so Claude Code, Codex, or Cursor wires the send correctly.
- Authentication
The X-Api-Key header, creating a key, and what the key errors mean.
- API reference
Every operation, generated from the same OpenAPI document the API is tested against.
- Errors
The problem+json body shape, every error code, and the rate limits.
- Distribution lists
Named recipient groups: managing lists and members, sending to a list, recipient variables, permissions, and rate limits.
- Email delivery and retries
The 30-second rule, three attempts, what each outcome means, and which providers report delivery.
- Webhooks
Verifying signed deliveries from an outbound webhook template.
- Domain authentication
Verify a sending domain with DKIM and SPF, and add a DMARC policy.