API Authentication - Zixflow Docs

Zixflow AI APIs use header-based authentication. You must include these headers in every request:

x-api-key: <your-api-key>
x-workspace-id: <your-workspace-id>

Required Headers

x-api-key: Your API key for the workspace.
x-workspace-id: Your workspace ID.

Where to find your API key and workspace ID

You can create/manage your API key and copy your workspace ID from the Zixflow dashboard:

Dashboard path: Settings > Developer > API Key
Direct link: https://ai.zixflow.com/settings/workspace/developer

Example request

curl -X POST "https://api-ai.zixflow.com/api/ingest/sms/v1/message/send" \
  -H "Content-Type: application/json" \
  -H "x-api-key: <your-api-key>" \
  -H "x-workspace-id: <your-workspace-id>" \
  -d '{ "recipient": "919876543210", "message": "Hello", "sender_id": "ZIXFLW", "route": "transactional" }'

Screenshot

Below is the screen where you can copy both API Key and Workspace ID: Zixflow dashboard showing API Key and Workspace ID

Zixflow dashboard showing API Key and Workspace ID

Introduction Postback Notifications