Skip to main content
Node type: set_workflow_state · Version: 1 · Category: Data Store a value after a successful run. sndbox classifies this node as side-effecting, so tests or automatic runs can require additional confirmation and permission review.

​
When to use this node

  • Persist a cursor, last successful timestamp, or small JSON-compatible checkpoint.
  • Make the next execution aware of work completed by the current one.

​
Example: Commit the latest API cursor

Store a mapped response cursor only after the entire workflow succeeds.
Example settings
This shows the important settings, not a complete exported node.
  1. Use a stable key.
  2. Map the new value from a successful upstream node.
  3. Place the node in the successful path and verify the whole run completes.

​
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 write is staged during execution and committed only after the workflow succeeds.
  • A failed or cancelled run leaves the previous committed value intact.
  • The editor catalogue declares value (any) 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

  • A successful node test previews the state update but deliberately does not commit it.
  • Workflow state is for small checkpoints, not secrets, files, or an unbounded event archive.

​
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.