flowboard
Skip to documentation

Task guide

Explain a runtime flow

Connect two services and inspect direction, speed and labels.

Before you start

Prerequisites
Two nodes in an editable diagram; the example below supplies both.
Permissions and plan
Local editing is free; published updates require write access.

Steps

  1. Import the example into a backed-up local editor.

  2. Select the existing API-to-database path to inspect it.

  3. Change its label, direction or animation speed in the inspector.

  4. To add a relationship, choose Connect, select a source node, then a different destination.

  5. Export the source and confirm the relationship is represented in the flows array or Flows section.

Runnable example

Flowboard Markdown

Copy this model into Import in the editor. Export current work first. The two stable identifiers, api and db, connect the services to the flow.

# Request path

- API {#api type=service x=100 y=120}
- Database {#db type=database x=500 y=120}

## Flows
- api -> db {#requests label="requests" color=#f05a47 speed=1 direction=forward}

Change a label to describe your system. Keep the identifiers the same when you want existing connections to keep referring to those nodes.

Check your work

Expected outcomeOne labeled relationship whose direction you can explain.

Next steps

Try the workflow in the editor, then use the reference for control details and model syntax.

If a step does not work, keep an export of your model and follow the troubleshooting guide. Include the error message when contacting support, without sharing credentials or private architecture.