Skip to main content

​
Base URL

All API requests should be made to: 
https://app.splox.io/api/v1

​
Webhook URL Format

Workflow webhooks use the same base URL: 
https://app.splox.io/api/v1/workflow-webhooks/{webhook_id}
Example: 
https://app.splox.io/api/v1/workflow-webhooks/0199eeeb-d60e-7ffd-9131-4cc5ab040ee7

​
Authentication

Webhooks can be configured as public (no authentication) or private (requires authentication). For authenticated endpoints, include your API token in the Authorization header: 
Authorization: Bearer YOUR_API_TOKEN
You can generate API tokens from your Splox Dashboard.

​
Endpoints

The Splox API provides these main endpoints:
  1. Trigger Workflow - Send data to webhook to execute workflow
  2. Listen to Execution - Stream real-time updates via SSE
  3. Get Execution Tree - Retrieve complete execution hierarchy
  4. Get History - View past executions
  5. Manage Chats - Create and retrieve chat sessions

​
Response Format

API responses return JSON data directly: Webhook trigger response: 
{
  "workflow_request_id": "0199f123-d60e-7ffd-9131-4cc5ab040ee8"
}
Use this ID to listen to execution, get the tree, or view history. Execution tree response: 
{
  "id": "0199f123-d60e-7ffd-9131-4cc5ab040ee8",
  "status": "completed",
  "workflow_version_id": "0199e001-a23b-7c8d-1234-567890abcdef",
  "query": { ... },
  "output": { ... },
  "created_at": "2025-10-22T12:15:30Z"
}

​
Support

Need help with the API? Reach out to us: