Note
Add annotations to the workflow canvas
The Note block is a sticky-note for the canvas. It doesn't run, read inputs, or produce outputs — it exists purely to document a workflow for the humans looking at it.
Notes are never executed. They have no effect on a run, so add as many as you like without changing behavior.
What it's for
Use Notes to leave context right next to the blocks they describe: why a branch exists, what a temporary workaround is for, or instructions for a collaborator picking up the workflow later. Because they render on the canvas itself, that context stays visible without anyone having to open a block's settings.
How to Use
- Drag a Note block onto the canvas and place it near the blocks it explains.
- Choose a Display Format — Plain text or Markdown.
- Write the Content.
Configuration
| Field | Description |
|---|---|
| Display Format | Plain text or Markdown. Controls how the content renders on the canvas. |
| Content | The text of the note. |
Example
A Note dropped next to a retry loop:
This loop retries the API call up to 3 times because the vendor's
endpoint intermittently times out under load. See ticket OPS-482.Switch Display Format to Markdown to use headings, lists, or bold text for longer explanations.