Skip to main content

Starting Workflow Executions

Workflow executions can be started by using the Conductor Dashboard, or via API:

The API endpoint is:

POST /api/workflow/{name}

The Parameters for each workflow execution are as follows (with how to use them in the API and a description):

ParameterAPI usageDescription
{name}URL pathThe workflow that is to be started.
versionURL query stringThe default version is the highest version number.
priorityURL query stringDetails Below
correlationIdURL query stringA correlationId can be added to a workflow as a way of filtering your executions.
POST BodyThe POST Body will have all the input parameters for the workflow execution. This can be empty.

Workflow Priority

The workflowPriority is an integer from 1-99, with 1 being highest priority, and 99 the lowest. If there are multiple workflow executions in the queue at the same time, the workflow execution with the lowest priority is selected.

The default value for priority is 0, which corresponds to a priority of 100 (i.e. if no priority is assigned, the execution goes to the end of the line.)

Using Client SDKs

Conductor offers client SDKs for popular languages which has library methods that can be used to make this API call. Refer to the SDK documentation to configure a client in your selected language to invoke workflow executions.

Example using curl

This example uses a runs at the Orkes Playground:

curl -X POST 'https://play.orkes.io/api/workflow/hello_world?version=2&priority=50' \
-H "X-Authorization: [access_token]']\
-H 'accept: text/plain' \
-H 'content-type: application/json' \
-d '{\"service\":\"fedex\"}'

In this example, the name of the workflow is hello_world, and we are running version 2 with a priority of 50. We specify one input param called service with a value of fedex