Skip to main content
Welcome to the Zixflow Events API. Use this service to send server-side events and manage user profiles.
Who this is for: Backend developers and integrators sending server-side events. Mobile and web app actions should use an SDK instead.

​
Base URL

All Events API endpoints are available at: 
https://api-events.zixflow.com
Events APIs use a different host and authentication scheme than messaging ingest (api-ai.zixflow.com with x-api-key / x-workspace-id). See Events Authentication.

​
API vs SDK

SDKsHTTP API
Who uses itWeb and mobile appsBackend servers, scripts, integrations
AuthAPI key in SDK initializationAuthorization: Basic base64(api_key:)
BatchingAutomaticManual via /v1/batch
When to useUser-facing app actionsServer-side events and profile updates from backend
Rule of thumb: If the event happens because a user tapped something in your app, use an SDK. If it happens on your server (fulfillment, billing, fraud detection), use this API.

​
API Groups

GroupBase pathPurpose
Data Pipelines/v1/Segment-compatible identify, track, screen, page, and batch
Group and Alias are not supported.

​
Data Pipelines (/v1/)

  • Identify — Create or update a user profile
  • Track — Record a user action or business event
  • Screen — Record a mobile screen view
  • Page — Record a web page view
  • Batch — Send multiple events in one request
All Data Pipelines requests accept Content-Type: application/json. Successful responses return HTTP 200 with an empty body {}.

​
Getting Started

  1. Obtain your API key from the Zixflow dashboard (Workspace Settings → API Keys).
  2. Authenticate with Basic Auth. See Events Authentication.
  3. Send events with the Data Pipelines endpoints above.
  4. Handle errors using the shared Events Errors reference.
For device, OS, app, IP, locale, and campaign fields, see Context Object.

​
Conceptual Guides

For product concepts (identity, attributes, devices, scenarios), see the Events documentation and the Event API conceptual reference.