Start Workflow Execution
Starts a workflow and returns the ID of the workflow. The API returns immediately without waiting for the workflow to be completed.
Input Payload
Parameter | Description |
---|---|
name | Name of the workflow. |
version | Choose the workflow version. |
input | Map of Key and Value given as the input to the workflow. |
correlationId | User-supplied correlation id, which can be used to query the workflow execution later. |
priority | Priority of the workflow. 0 is the default priority, which executes workflows in FIFO. Valid values are from 0-99. |
taskToDomain | Task to Domain limits the workflow execution to the specified domain only. |
workflowDef | Provide the entire workflow definition. Used for executing ephemeral workflow definitions. |
Response
A string representing the id of the workflow execution.
API Endpoint
POST /api/workflow/{name}
SDK Methods
- Java
- Golang
- Python
- CSharp
- Javascript
- Clojure
String startWorkflow(StartWorkflowRequest startWorkflowRequest)
func (e *WorkflowExecutor) StartWorkflow(startWorkflowRequest *model.StartWorkflowRequest) (workflowId string, err error)
WorkflowResourceApi.start_workflow(self, body, **kwargs)
string WorkflowResourceApi.StartWorkflow(StartWorkflowRequest body)
WorkflowResourceService.startWorkflow1(
name: string,
requestBody: Record<string, any>,
version?: number,
correlationId?: string,
priority?: number,
): CancelablePromise<string>
(workflow-resource/start-workflow [options start-workflow-request])