run-workflow
Start a workflow by specifying its ID and starting component. Optionally set version and placeholder values to customize execution.
Instructions
A command for starting a workflow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflowId | Yes | The ID of the workflow to run | |
| componentId | Yes | UUID identifier of the component to start running from Example: 3fa85f64-5717-4562-b3fc-2c960000afa6 | |
| workflowVersion | No | Workflow version to run. It could be a integer version or 'DRAFT' or 'PUBLISHED'. If DRAFT OR PUBLISHED, will run latest version of the project with the respective status | |
| placeholderValues | No | A object containing placeholder keys and values to override values from the original session. - Keys must be from the set of placeholders available to the specified component. - All keys are optional at the API level, but omitting them may of course cause the workflow to fail. - Values are validated against the placeholder type. - datetime placeholders MUST be in ISO-8601 format, but may omit timezone, offset, or the whole time portion. - list placeholders MUST EITHER be sent as a JSON List or a Bracketed String (see example). - Values may not be sent as JSON objects, instead keys should use dotted form. |