Notes

Audience: Low-code Engineers

Skill Prerequisites: Actions

Adds development notes to an action list. The action does nothing when it runs. It's there so you, or other low-code engineers, can read why the actions are set up the way they are.

The notes are written in a rich text editor, so they can have headings, bold text, lists and links.

Typical Use Cases

• Explain what an action list does at the top of a workflow, API endpoint, form or grid event
• Record business rules, assumptions or edge cases that aren't obvious from the actions
• Leave instructions for the next person who changes the actions, for example which tokens they must keep
• Keep a short change history or a to-do list next to the actions it's about

Don't use it to

• Label a single action. Use that action's Description instead, which is shown on the collapsed action. See Common Parameters.
• Write to the logs while actions run. Use Log Debug Message or Log Event instead.
• Store data or settings that the actions need. Notes can't be read by other actions or tokens.

Related Actions

Action Name	Description
Execute Actions	Groups actions. Put a Notes action first in the group to explain it.
Log Debug Message	Writes a message to the logs while actions run.

Notes or Description?

Every action has a Description (Common Parameters). Use the one that fits:

	Description	Notes action
Length	One short line	As long as you need
Formatting	Plain text	Rich text
Visible	On the collapsed action	When you open the action
About	That one action	The whole list, or a group of actions

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Notes	The text of the notes, in rich text. It's saved with the action and never processed.	No	empty string	No

Considerations

• No effect at runtime. The action doesn't change tokens, data or the result. Actions before and after it run as if it weren't there.
• Tokens aren't replaced. You can write [OrderId] in your notes and it stays as typed.
• Available everywhere. You'll find it in the Code group in every module that has actions.
• Leave the Condition empty. A condition has nothing to control. Give it a short Description, such as Read me, so it stands out in the list.
• Don't write secrets. Anyone who can edit the actions can read the notes, and they're included when the actions are exported.

Examples

tip

To understand how to use the below examples, please see Running Examples.

1. Explain an order approval workflow

This action describes what the actions after it do and which rule they apply.

{
    "Title": "Notes",
    "ActionType": "Notes",
    "Description": "Read me: how approvals work",
    "Parameters": {
        "Notes": "<p>Approves or rejects new orders.</p>\n<ul>\n<li>Orders up to <strong>$5,000</strong> are approved automatically.</li>\n<li>Larger orders are sent to the manager in <strong>[ManagerEmail]</strong>.</li>\n</ul>\n<p>Keep the <strong>[OrderId]</strong> token. The email template uses it.</p>"
    }
}

Revised 09/26/2026