You can now add descriptions to reusable flows! Flow descriptions are an optional field where you can note how a flow should be used, any caveats, and clarifications about its purpose. While the flow's name remains the primary identifier you see in tables and pickers, the description can carry the context your teammates need to reuse the flow correctly, such as "Assumes a seeded admin account" or "Only safe against the staging environment".
Descriptions appear wherever you or the mabl agent chooses or reviews flows:
- Flows table: a new Description column shows each flow's description alongside its name.
- Flow details: the description appears under the flow's name.
- mabl Trainer: hovering over a flow in the flow picker shows its description in the tooltip.
- The mabl agent takes flow descriptions into account when searching your workspace for flows to reuse.
Descriptions are completely optional and start out empty in existing flows.
How to add a flow description
You can add a flow description anywhere you edit a flow's information.
Flow details page
Click on the edit icon and fill in the Description field.
mabl API
Add a description to an existing flow with the update flow metadata endpoint.
mabl Trainer
On the latest version of the mabl Desktop App, the flow form includes a Description field when you create or edit a flow.
When importing a flow, hover over a flow's name to see its description.
API Test Editor
On the latest version of the mabl Desktop App, the Edit flow modal has separate Name and Description fields.
Learn more
For guidance on building flows worth reusing, see Creating effective flows. For flows in API tests, see Working with flows in API tests.