> For the complete documentation index, see [llms.txt](https://flapjax.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://flapjax.gitbook.io/docs/automations/flow-builder.md).

# Flow Builder

### Top Bar

The bar at the top of the builder contains:

* **Back button** returns you to the automations list.
* **Category emoji** assigns or changes the automation's category on click.
* **Name** renames the automation inline. It saves as you click away, or on Enter.
* **Description** is an expandable text area under the name, for context about what the automation does. It saves as you click away.
* **Status toggle** switches the automation between Live and Draft. See Statuses below.

***

### Statuses

The status toggle in the top bar controls whether the automation is running:

* **Draft**, in grey, means inactive. The automation processes nothing.
* **Live**, in green, means active and running.
* **Scheduled**, in purple, replaces "Live" on a trigger set to a specific future date and time.

The toggle sits disabled as long as any action in the flow lacks its full configuration. A yellow **Setup incomplete** badge beside the name reminds you.

**Fired:** a one-time scheduled automation that already ran swaps the toggle for a "Fired" badge carrying the execution date.

**Paused:** the system pauses an automation as soon as it detects a problem, such as a deleted segment, a removed attribute or an endless loop. An orange warning banner at the top of the canvas gives the specific reason. Fix the underlying issue to resume.

***

### Canvas Controls

A floating toolbar at the bottom-left of the canvas provides:

* **Pan mode**, the hand icon and the default. Click and drag to move around the canvas.
* **Select mode**, the pointer icon. Click and drag to draw a selection box around several nodes.
* **Add Note** places a sticky note on the canvas. See Notes below.
* **Zoom menu** zooms in and out, jumps to 50%, 100% or 150%, and fits the whole flow to your screen. Hover shows the current zoom percentage.

***

### Adding Actions

Click the **+** button on the edge between any two nodes. An action selector panel opens with:

* A **search bar** that filters actions by name
* A **categorised grid** of every available action type, each with an icon and a name
* A **Custom Actions** section at the bottom, listing the webhook actions you created in Settings

Click an action to drop it into the flow at that position. A loading indicator runs as Flapjax creates it.

{% hint style="info" %}
**Note:** the **+** button appears on automations in Draft or Paused status alone, and the trigger needs configuring first. A tooltip explains as much on an unconfigured trigger.
{% endhint %}

***

### Configuring Actions

Click any node to open its **configuration panel** on the right side of the canvas. The panel shows:

* **Header**, carrying the action's icon, title and ID number. An action missing part of its configuration shows a "Setup incomplete" tag. A "Syncing" indicator flashes as changes save.
* **Description**, an editable field for notes about what this action does.
* **Configuration form**, the settings for this action type: fields, dropdowns, rule builders and the rest. See [Actions](/docs/automations/actions.md) for each type.
* **Delete action**, the red text at the bottom, which removes this action from the flow.

**Auto-save:** configuration changes save a moment after you make them. Closing the panel saves too. **Escape** closes the panel.

**Full view mode:** the expand button in the panel header widens it for complex configurations. Click again for normal width.

***

### Read-Only Mode

An automation in Active, Scheduled or Fired status puts the builder into read-only mode:

* Nodes stay where they are, with no dragging or rearranging.
* Configuration fields grey out.
* Adding and deleting actions stops.
* The + buttons on edges disappear.

Toggle the automation back to Draft to make changes.

***

### Sticky Notes

Sticky notes annotate the canvas with context for your team. They sit apart from the flow and change nothing about how the automation runs.

Click **Add Note** in the toolbar, or drag it onto the canvas. Notes support:

* **Editable text.** Click to type, and it saves as you click away.
* **Colour picker**, for a background colour that groups notes visually.
* **Resize**, by dragging the corner handle. The minimum is 200 by 150 pixels.
* **Delete**, by hovering the note and clicking the delete button.

Each note shows the avatar of the person who last edited it.

***

### Setup Incomplete Checklist

Actions missing part of their configuration raise a badge with a count in the bottom-left toolbar. Click it for a floating checklist of each incomplete action, with its icon and name. Click any item and the canvas jumps to that node with its configuration panel open.

***

### Edge Labels

Branching actions label the edges leaving a node, so you can see which path each branch takes:

* **If/Else** labels them "True" and "False".
* **Switch/Case** labels each case by name, plus "Default".
* **Randomize Flow** labels each path by name.
* **Delay Until Event** labels each event, plus "End of Delay" for the timeout path.

***

### Opening the runs view

Click **Participants** on a sequence, or **Runs** on a workflow, in the bottom-left toolbar. Execution history opens. The Monitoring guide covers it in detail.
