branch

This block is part of the flow group and was last modified in core v10.4.28.

branch v10.4.28

In pins 1 + flow
  • flow
    flow
  • condition required
    condition
Out pins 0 + flow
  • true
    flow
  • false
    flow

Routes to the true out pin only when the condition input is exactly boolean true; any non-boolean value (even truthy ones like 1 or "yes"), nil, or an unwired pin follows the false pin. No coercion. Example: condition=1 -> the false pin runs (1 is not boolean true).

branch
if

A function trigger runs the flow, a == comparison feeds the condition pin, and branch sends the flow down the true or false out pin, here into two debug blocks. The fixed value would be live data in a real blueprint.

Studio canvas example for the branch block: splitting the flow on a condition.

Commonly used with

One of the most-used blocks across production blueprints. It is most often wired together with:

  • reply in JSON: this block feeds into it. Reply to any httpconnection as JSON body.
  • get document: wired in both directions with this block. get a specific document based on the given GUID.
  • execute: feeds into this block. Executes the given funcion and waits for it to be executed.
  • branch: wired in both directions with this block.
  • update document: this block feeds into it. Update document in the given storage and creates a revision for it.
  • AND: feeds into this block. operator for a set of boolean operands will be true if and only if all the operands are true.

Used in these guides

These documentation pages use or explain this block:

Version history

Introduced in v10.4.28.


Back to flow Return to the main group to view all sub-groups Back to flow Return to the group to view all blocks within this group