DocsNodesStarts the workflowClient message

Client message

Starts a run when a client sends a message of the type you pick. Add conditions to start only on the readings that matter, and a hold to start only when they keep mattering.

Kindtrigger:client
GroupStarts the workflow
CreditsFree
Ports out1

How it looks

Settings

SettingRequiredWhat it does
ClientclientRefYesThe client to listen to.
Message typetypeYesThe type the board sends, like temperature. * starts on any type.
ConditionsfilterNoChecked against the message before a run starts, like celsius > 30. A run starts only when they hold. A condition that can't be checked counts as not matching, so a bad reading never starts a run by accident.
Hold forholdSecondsNoThe conditions must keep holding this long before a run starts, up to 24 hours. After that the trigger stays quiet until a message stops matching. Needs conditions.
If it fires while a run is still goingconcurrencyPolicyNoQueue by default. See Runs that overlap below.
Correlation keycorrelationKeyNoWhich runs count as the same for the setting above. Left empty, the client and message type. Set it to share one line with another trigger.

Ports

PortThe run leaves by it when
defaultAlways. The message is the run's input.

What it adds to the run

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

ValueHolds
triggerThe message the board sent. Its values are under trigger.payload, so {{trigger.payload.celsius}} in a later node is the reading.
triggeredAtWhen the trigger fired.

Example

Fridge door left open

  1. Message type door, condition open == true.
  2. Hold for 10 minutes.
  3. Connect a Telegram node. You hear about it once, ten minutes in, not on every reading, and again only after the door has closed and opened.

Runs that overlap

What happens when the trigger fires again while a run with the same correlation key is still going.

SettingWhat happens
QueuedefaultThe new event waits. When the run finishes, the oldest waiting event starts the next one. Events wait up to 24 hours.
Allow parallelAnother run starts alongside.
Drop if runningThe new event is dropped.
Cancel existingThe running one is cancelled and a new one starts.

Problems you might see

CodeMeans
INVALID_CLIENT_REFThe client isn't one in this workspace. Shown when you publish.
HOLD_REQUIRES_FILTERHold for is set without any conditions to hold.
INVALID_HOLD_DURATIONHold for is negative or over 24 hours.

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.