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".
Kind
control:awaitSignalGroupWaits
Credits0.1 credits
Ports out1 or 2
How it looks
Settings
| Setting | Required | What it does |
|---|---|---|
| Signal namesignalName | Yes | The name to wait for, like approved. |
| Give up afterttl | No | Optional. With it, the node also has a timeout port. |
| Correlationcorrelation | No | Which run the signal must be sent to. Left empty, this run. Use {{trigger.payload.parentRun}} to wait on another run's signal. |
Ports
| Port | The run leaves by it when |
|---|---|
default | The signal arrived. |
timeout | Only 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.
| Value | Holds |
|---|---|
signalPayload | The body sent with the signal. |
Example
POST /api/v1/workspaces/<workspace>/runs/<run>/signals/approved
Authorization: Bearer <token>
{ "by": "Sam" }Problems you might see
| Code | Means |
|---|---|
SIGNAL_CORRELATION_MISSING | Correlation filled in to nothing, so there's no run to wait on. |
AWAIT_SIGNAL_CORRELATION_INVALID | Correlation 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.
See also
Parks the run on a one-off callback URL until something calls it, or the time runs out.
Outdefaulttimeoutcontrol:waitForHttpStarts another workflow as a child run, with its own credits, and passes the result back.
Outdefaultcontrol:subWorkflowStarts from the Run button in the console or from the API, with inputs you define.
Outdefaulttrigger:manual