DocsNodesStarts the workflowRun by hand

Run by hand

Starts a run when someone presses Run now in the console, or calls the API. It can ask for inputs first, and it's also how one workflow starts another with Run workflow.

Kindtrigger:manual
GroupStarts the workflow
CreditsFree
Ports out1

How it looks

Settings

SettingRequiredWhat it does
What "Run now" doesdescriptionNoA line shown next to the Run now button, like "Power-cycles the soil sensor".
Ask for inputinputsNoFields the console asks for before starting, each with a name, a label and a default. A value left out takes its default. Names are letters, digits or underscores, and can't be parentRunRefId, correlationKey or depth.

Ports

PortThe run leaves by it when
defaultSomeone started a run.

What it adds to the run

Later nodes can read these, in a condition or as {{name}} in a text field.

ValueHolds
triggerThe inputs, by name. An input called reason is {{trigger.payload.reason}}.
triggeredAtWhen the trigger fired.

Example

start a run from the API
POST /api/v1/workspaces/<workspace>/workflows/<workflow>/runs
Authorization: Bearer <token>

{
  "triggerNodeId": "<the manual trigger's node id>",
  "payload": { "reason": "testing the relay" },
  "idempotencyKey": "relay-test-1"
}
Answers200 started, 202 queued behind a run that's still going, 409 dropped by the concurrency setting or the workflow has no manual trigger. Starting a run needs workflows.execute.

Problems you might see

CodeMeans
MANUAL_INPUT_NAME_INVALIDAn input name isn't letters, digits or underscores, starting with a letter or underscore.
MANUAL_INPUT_NAME_DUPLICATETwo inputs have the same name, ignoring case.
MANUAL_INPUT_NAME_RESERVEDAn input uses a name WBSKT writes itself.

Problems found when you publish stop the publish and point at the node. Problems while a run is going fail the node, and its On failure setting decides what happens next. See the error codes for the API's own.