Endpoint
Authentication
This endpoint requires an OAuth access token. Send it as a bearer token:workflows:write
The task is created as the access token’s user, who must be at least a requester on the workflow.
The
user field on the request body is ignored.Path Parameters
Request Body
The request body must be a JSON object with the following fields:Required Fields
Optional Fields
Attribute Format
Each attribute is a simple object withkey and value fields:
- Exact match by variable ID
- Case-insensitive match by variable title
- Normalized match (lowercase, spaces/underscores/hyphens ignored)
All values are provided as strings. The system will automatically convert them to the appropriate type based on the workflow schema.
File Format
Files are provided separately from attributes:Files are validated against the platform’s supported file extensions. Files with unsupported extensions are skipped rather than coerced.
When to Use This Endpoint
This endpoint is designed for scenarios where the integrating system or user cannot maintain variable-specific mapping and control. Use this endpoint when:- Generic integration systems that handle multiple workflows without custom configuration for each
- Low-code/no-code platforms where users configure integrations through UI without coding
- Form builders that generate dynamic field mappings based on workflow schemas
- Third-party tools that need to integrate with workflows but can’t be customized for each workflow’s schema
- Rapid prototyping where you want to test workflows without setting up precise type mappings
- Simple scripts where maintaining detailed variable schemas adds unnecessary complexity
If your integration requires precise control over variable types, file references, or needs to distinguish between fields with similar names, use the standard Initiate Workflow endpoint instead.
Request Example
Response
Success Response
Status Code:200 OK
Response Fields
Error Responses
400 Bad Request
Returned when the version format is invalid, the request structure is malformed, or the access token has no user behind it.client_credentials tokens act as the admin who created the application, so this applies only to
tokens issued before application creators were recorded.
401 Unauthorized
Returned when the access token is missing, unknown, revoked, or expired, or when anX-API-Key was
sent instead of a bearer token. See OAuth error responses.
403 Forbidden
Returned when the token lacks the required scope:404 Not Found
Returned when the workflow or version does not exist.422 Validation Error
Returned when the request body is invalid or required variables are missing.429 Too Many Requests
Returned when your organization exceeds its per-minute request limit.500 Internal Server Error
Returned when workflow initiation fails due to a server error.Comparison with /initiate
Notes
Save the
task_id from the response to track the workflow’s progress using the
Get Task endpoint, or hand task_url to the user to open the
task in Chamelio.Attributes that match no workflow field are dropped unless
auto_creation_of_extra_variables is
true, in which case they are passed to the workflow as extra variables to create.Use Cases
This flexible endpoint is ideal for:- Generic integration platforms - iPaaS solutions (Zapier, Make, Workato) that connect to multiple workflows without per-workflow configuration
- Form builders - Dynamic forms that adapt to workflow schemas without hardcoded field mappings
- No-code tools - Platforms where users configure integrations visually without access to variable IDs
- Multi-tenant systems - Applications serving multiple organizations with different workflow schemas
- Rapid prototyping - Quick testing without setting up precise variable mappings