Skip to main content
Version: 5.1

Start a Workflow

A workflow does not start itself. Something has to launch it. It can be any type of trigger: a service resource that receives a request, an automation that runs on a schedule, a file handler that runs when a file arrives, or an operator starting one by hand. Whatever the trigger, starting a run returns a workflow ID, and that ID is the handle to the run from then on.

A POST resource that starts a workflow: a Run Workflow step capturing workflowId, with a link across to the orderWorkflow it starts, followed by a Return of that same workflowIdA POST resource that starts a workflow: a Run Workflow step capturing workflowId, with a link across to the orderWorkflow it starts, followed by a Return of that same workflowId

Start one from an integration​

  1. In the trigger artifact flow design, click +.

  2. In the node panel, under Workflow, click Run Workflow. The panel lists the workflows in the project; click the one to start.

    The node panel with Run Workflow and Send Data Event under the Workflow groupThe node panel with Run Workflow and Send Data Event under the Workflow group

  3. Fill in the form:

    FieldRequiredDescription
    WorkflowYesThe workflow to start. It is preselected with the one you clicked, and can be changed here.
    InputYesThe data the workflow starts with. It must match the workflow's input type. Pick the request payload from Inputs in the value helper.
    Workflow ID Variable NameYesThe variable that receives the ID of the started run.

  4. Click Save.

Adding a Run Workflow step that starts shipmentWorkflow with the request payloadAdding a Run Workflow step that starts shipmentWorkflow with the request payload

The step is drawn with an arrow across to the workflow it starts, so an entry point shows at a glance which process it kicks off. Click that marker to open the workflow itself.

Starting returns immediately​

Run Workflow starts the run and returns its ID straight away. It does not wait for the workflow to finish, and that is the point: a durable workflow may sit on a human task or a data event for days, and no caller should be held open for that.

So hand the ID back to whoever will need it:

  • Return it in the response, so the caller can ask about the run later.
  • Store it against your own record, such as the order row, so the process can be traced from your data.
  • Include it in the callback URL you give a partner system, so the value they post comes back to the right run.

Other ways to start a run​

RouteUse it for
Integration Control PlaneStarting a run by hand from a generated form, for testing, onboarding, and operations.
Management APIPOST /workflows for custom portals and automation of your own.

Next steps​

Last updated on
On this page
Was this page helpful?
Report an issue