Skip to main content
Welcome to Zixflow AI API Ingestion Service documentation. This service provides unified APIs for sending messages across multiple channels including Email, SMS, WhatsApp, RCS, and managing Transflow automations.

​
Base URL

All API endpoints are available at: 
https://api-ai.zixflow.com/api/ingestion

​
Supported Channels

The Zixflow AI Ingestion Service supports the following communication channels:
  • Email: Send email messages and templates
  • SMS: Send SMS messages and templates
  • WhatsApp: Send various WhatsApp message types including text, media, interactive messages, and templates
  • RCS: Send Rich Communication Services messages including text, media, and templates
  • Transflow: Trigger and manage automation workflows

​
Authentication

The API uses custom header authentication. Include the following headers in all requests: 
x-api-key: <your-api-key>
x-workspace-id: <your-workspace-id>
Required Headers:
  • x-api-key: Your API key obtained from the Zixflow dashboard
  • x-workspace-id: Your workspace ID

​
API Usage Guidelines

  • All endpoints accept JSON-encoded request bodies
  • Responses are returned in JSON format
  • The API follows RESTful principles
  • Rate limits may apply - check response headers for rate limit information

​
Getting Started

  1. Obtain your API key and workspace ID from the Zixflow dashboard
  2. Include both headers (x-api-key and x-workspace-id) in all requests
  3. Use the appropriate endpoint for your communication channel
  4. Refer to the specific endpoint documentation for request/response formats

​
Response Format

Most endpoints return a standard response format: 
{
  "status": true,
  "message": "Success message"
}
For detailed response structures, refer to individual endpoint documentation.