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.
Kind
trigger:manualGroupStarts the workflow
CreditsFree
Ports out1
How it looks
Settings
| Setting | Required | What it does |
|---|---|---|
| What "Run now" doesdescription | No | A line shown next to the Run now button, like "Power-cycles the soil sensor". |
| Ask for inputinputs | No | Fields 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
| Port | The run leaves by it when |
|---|---|
default | Someone started a run. |
What it adds to the run
Later nodes can read these, in a condition or as {{name}} in a text field.
| Value | Holds |
|---|---|
trigger | The inputs, by name. An input called reason is {{trigger.payload.reason}}. |
triggeredAt | When the trigger fired. |
Example
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
| Code | Means |
|---|---|
MANUAL_INPUT_NAME_INVALID | An input name isn't letters, digits or underscores, starting with a letter or underscore. |
MANUAL_INPUT_NAME_DUPLICATE | Two inputs have the same name, ignoring case. |
MANUAL_INPUT_NAME_RESERVED | An 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.
See also
Starts another workflow as a child run, with its own credits, and passes the result back.
Outdefaultcontrol:subWorkflowEnds this path as done, optionally handing a value back to the run that started it.
Outnone, it ends this pathcontrol:endParks the run until a named signal arrives from the console, the API or another run.
Outdefaultwith Give up aftertimeoutcontrol:awaitSignal