Endpoint
Authentication
This endpoint requires authentication via API key. Include your API key in theX-API-Key header:
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)
Values are provided as strings. The system will automatically convert them to the appropriate type based on the workflow schema. Amounts with an explicit currency and table fields work differently, as described below.
Amounts with a currency
For anumber_with_currency field, a plain string such as "50000.00" uses the field’s default currency. To set the currency, send value as an object with value and currency:
currencies. An attribute with a currency must match a number_with_currency field. If it matches no field, or matches a field of another type, the request returns a 400 instead of skipping the attribute.
Table fields
For adynamic_table field, send value as a string containing a JSON array of rows. Each row is an object keyed by column name, or a list of cells in column order, as described in Dynamic Table InputValue:
400.
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, request structure is malformed, attribute matching fails, or a currency or table attribute fails the workflow’s rules.401 Unauthorized
Returned when authentication fails. See the authentication errors section for details.404 Not Found
Returned when the workflow or version doesn’t exist.422 Validation Error
Returned when the request body is invalid or required variables are missing.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.Use Cases
This flexible endpoint is ideal for:- Generic integration platforms - Integration platforms (iPaaS) 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
- API aggregators - Services that normalize data from various sources before initiating workflows
- Rapid prototyping - Quick testing without setting up precise variable mappings
- Simple scripts - Automation where maintaining detailed schemas is unnecessary overhead