Stateway API
The Stateway API is a RESTful interface for managing BPMN 2.0 process definitions, instances, tasks, timers, webhooks, and decisions. All endpoints require authentication via API Key (except health checks and registration).
Base URL
https://api.stateway.io
Authentication
Include your API key in the X-API-Key header:
curl -H "X-API-Key: sw_live_xxxxxxxx" https://api.stateway.io/v1/definitions
Interactive API Explorer
Use the Swagger UI below to explore all endpoints, request/response schemas, and test the API interactively.
tip
The explorer loads the live OpenAPI specification. You can also download the raw spec at /openapi.json.
API Categories
| Category | Description |
|---|---|
| Auth | Register tenants and manage API keys |
| Definitions | Create, update, version, and deploy BPMN process definitions |
| Instances | Start, suspend, resume, terminate, and inspect process instances |
| Tasks | Claim, complete, delegate, and unclaim human tasks |
| Events | Send messages and broadcast signals to running instances |
| Timers | List and cancel scheduled timer jobs |
| Webhooks | Subscribe to events and inspect delivery attempts |
| Decisions | Create DMN decision tables and evaluate them |
| Credentials | Store and rotate encrypted secrets for service task headers |
| Monitoring | Operational metrics for process health and service reliability |
| Tenant | Manage tenant settings |
| Health | Liveness and readiness probes |
API Explorer
Browse all endpoints, view request/response schemas, and test the API interactively.
caution
The "Try it out" feature requires a valid API key. Register a tenant and obtain an API key before testing endpoints.