Skip to main content
Node type: get_workflow_state · Version: 1 · Category: Data Read a value stored by this workflow. This node is not marked with the catalogue’s generic side-effect flag. That classification is not a guarantee that every configured operation is read-only; review the concrete action and its destination.

​
When to use this node

  • Read a checkpoint, cursor, last-seen value, or preference saved by this workflow.
  • Provide a default for the first run without confusing a missing key with stored null.

​
Example: Read the last processed cursor

Return zero on the first run and the stored cursor on later runs.
Example settings
This shows the important settings, not a complete exported node.
  1. Choose a stable, workflow-specific key.
  2. Branch on found if stored null and missing must differ.
  3. Map value into the request or comparison that needs the checkpoint.

​
Configuration

State writes are committed only after the complete workflow succeeds. Node tests only preview state changes.

​
Workflow JSON

The editor stores this node with the following implemented default configuration:
Default node configuration
Values may be entered literally or mapped from an earlier compatible output when the inspector exposes a mapping control. See Variables and data mapping.

​
Inputs

​
Outputs

​
Execution behavior

  • The output includes value and a separate found boolean.
  • Node tests can read committed state but do not commit state changes produced elsewhere in the test.
  • The editor catalogue declares value (any), found (boolean) for mapping. The execution inspector can contain additional evidence fields; inspect a real result before selecting nested paths from object or any outputs.

​
Common issues

  • State belongs to one workflow; copying a node to another workflow does not copy its stored value.
  • Use an explicit default whose type matches what downstream nodes expect.

​
Where it can run

  • Desktop local runner
  • Paired self-hosted runner
  • Hosted runner

​
Test and inspect

Use Test node in the editor to preview this step with the current configuration. A full run records resolved inputs, outputs, logs, duration, and any artifacts in the execution inspector. Side-effecting or destructive nodes can require an additional confirmation or approved workflow permission.