Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.fluxomail.com/llms.txt

Use this file to discover all available pages before exploring further.

List events 
BASE=https://api.fluxomail.com
curl -X GET "$BASE/api/v1/events?types=email.delivered&limit=50" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fluxomail-Version: 2025-09-01"
Realtime (SSE) 
curl -N "$BASE/api/v1/events/stream?types=email.*" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Accept: text/event-stream"
Resume semantics
  • Servers accept since=<eventId> (query) and Last-Event-ID (header). The SDK sends Last-Event-ID automatically in Node when resuming.
Browser pattern 
const res = await fetch('/api/fluxomail/token', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ organizationId: '<orgId>' }) });
const { token } = await res.json();
const es = new EventSource('/api/v1/events/stream?types=email.*&token=' + encodeURIComponent(token));
Response envelope 
{
  "id": "send_abc123:1717861234567",
  "type": "email.delivered",
  "created": "2025-09-01T12:34:56.789Z",
  "data": { "sendId": "send_abc123", "providerMessageId": "...", "metadata": {} }
}