Authentication

FlowAlert's supported public API surface authenticates with an API key.

API key authentication

Used when sending events from your application. Pass the key in the X-Api-Key header:

curl -X POST https://api.flowalert.io/v1/events \
  -H "X-Api-Key: fa_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "event": "order.created", "title": "New Order", "body": "Order #4821" }'

Create and manage API keys in Dashboard → Setup → API Keys.

⚠️

API keys are workspace-scoped. Keep them server-side only — never expose them in browser JavaScript or mobile app code.

Validate a key

GET /v1/events/ping

Authenticated with X-Api-Key. Returns the workspace the key belongs to — useful for "test connection" buttons in integrations:

{ "ok": true, "workspaceId": "ws_xyz", "workspaceName": "My Business" }

Dashboard endpoints (internal)

Endpoints under /v1/workspaces/… are used by the FlowAlert dashboard and mobile app. They authenticate with a session token issued by our sign-in flow — there is no public login or registration endpoint, and API keys cannot call them. They're documented in this reference for transparency, but they're internal and may change without notice. The supported integration surface is POST /v1/events.

Python Events