DocsNodesWaitsWait for signal

Wait for signal

Parks the run until a named signal arrives for it, from the console, the API or another run. Use it for "wait until someone says go".

Kindcontrol:awaitSignal
GroupWaits
Credits0.1 credits
Ports out1 or 2

How it looks

Settings

SettingRequiredWhat it does
Signal namesignalNameYesThe name to wait for, like approved.
Give up afterttlNoOptional. With it, the node also has a timeout port.
CorrelationcorrelationNoWhich run the signal must be sent to. Left empty, this run. Use {{trigger.payload.parentRun}} to wait on another run's signal.

Ports

PortThe run leaves by it when
defaultThe signal arrived.
timeoutOnly with Give up after: no signal in time.

What it adds to the run

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

ValueHolds
signalPayloadThe body sent with the signal.

Example

send the signal
POST /api/v1/workspaces/<workspace>/runs/<run>/signals/approved
Authorization: Bearer <token>

{ "by": "Sam" }

Problems you might see

CodeMeans
SIGNAL_CORRELATION_MISSINGCorrelation filled in to nothing, so there's no run to wait on.
AWAIT_SIGNAL_CORRELATION_INVALIDCorrelation could never fill in to a value. Shown when you publish.

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.