Note Step

The Note step adds inline documentation directly to your workflow.

It does not affect execution or evaluation outcomes — it provides context and supports collaboration.

When to use Notes

• Explain logic: Document why certain rules, conditions, or enrichments exist.
• Highlight key decisions: Call out business logic or thresholds important for reviewers.
• Collaborate: Share feedback, ask questions, or suggest changes while designing workflows.
• Track assumptions: Record considerations or limitations relevant to the workflow’s design.

Configure a Note step

1. Right-click anywhere on the workflow canvas to open the step menu.
2. Select Note.
3. Enter your text in the side panel.
4. Save the workflow.

📘

Note:

• Notes are visible when reviewing the workflow in the UI but are not included in API responses.
• You can edit or delete notes at any time without affecting workflow behavior.

Best practices

• Keep notes concise: Summarize logic or intent in a few clear sentences.
• Use consistent language: Write so both technical and non-technical stakeholders can understand.
• Update regularly: Revise notes as workflows evolve to keep them accurate.
• Avoid sensitive data: Never include personally identifiable information (PII) or secrets in notes.