> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heybreez.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

The Workflow Builder is the heart of the HeyBreez app. It is where you design and manage the logic your **agent** follows during a call. It provides a visual environment for building the flow of your calls, defining behavior, and testing how your workflow runs — all without writing code.

This section introduces the builder’s layout, navigation tools, workflow states, versioning, and the controls available while editing.

***

## Top Navigation & Workflow Status

At the top of the builder, you’ll see key information and controls for the workflow you’re editing:

#### Workflow Name & Breadcrumbs

* Shows the workflow’s name (editable when clicking on it).
* Breadcrumbs indicate the organization and project this workflow belongs to.

#### Version Selector

* Displays the version you’re currently viewing.
* Clicking opens a dropdown of all **saved and published** versions.
* Selecting one loads that specific version in the workflow builder.

#### Draft Badge

Indicates that the workflow has **unsaved changes** compared to the latest published version. A workflow becomes “Draft” as soon as:

* Any node is moved
* A setting is changed
* A connection is modified
* Anything in the underlying definition differs from the published version's JSON

#### Compliance Badge

Visible on published versions that have been evaluated.\
Possible states:

* **Compliant**
* **Compliance Pending**
* **Not Compliant**

***

## Workflow Controls

Under the top nav bar are the main controls for testing, publishing, and managing the workflow.

#### Test

Runs a **local test simulation** inside the builder. This is not a real call, it's a web call.

If you have any **Workflow Outputs** defined in the Workflow Properties menu, you will be prompted to provide these before initiating the test.

Once a test call is initiated, the **Test** button changes to an **End Test** button and a test console pops up in the bottom right corner that shows the following:

* Voice mode: Transcription of the voice conversation between the caller (you) and the agent is shown
* Chat mode: if you are unable to speak and/or only want to test the agent's logic (LLM), use chat mode and type out the caller's (your) responses. The agent will respond out loud and be transcribed in the chat
* Current duration of the test call
* Mute button: you are able to mute your microphone so the transcriber doesn't capture what you're saying (useful in demo settings)

#### Call

Places a **real outbound call** through the selected phone number.

* Opens a selector to provide the following
  * Number Group to use as the Source to call from
  * Recipient Phone Number
  * Workflow Input values
* Hidden when the workflow is in draft mode.

#### Save & Publish

Saves your changes and creates a **new numbered version**. You can provide:

* Tags (optional)
* Description (optional)

Once published, the version becomes immutable. This button is hidden when the workflow is already Saved & Published and no additional changes have been made.

### **Reset**

Reverts the builder back to the **latest published version**, discarding all draft changes. This cannot be undone.\
Only visible when a workflow is in draft status.

### **Undo/Redo**

Goes one step backward or forward in changes you have made to the workflow while in draft status.

#### Ellipses Menu (⋯)

Provides advanced management actions:

* **Import**: Load a workflow from a JSON file.
* **Clone From Library**: Copy any workflow you have access to, including global public workflows.
* **Download JSON**: Export the current workflow (draft or published) as JSON.

***

## Navigation, Zooming & View Controls

Located in the bottom-left corner:

#### Fit View

Re-centers and zooms the canvas so the entire workflow is visible.

#### Show / Hide Background Dots

Toggles the dotted grid background.

#### Panning

You have two options for how to move around the canvas:

* Scroll pan *(default)*: scroll horizontally or vertically on a trackpad, this activates the mini-map in the bottom-right. You can click and drag inside the mini-map to move around the workflow. Clicking and dragging outside the mini-map will allow you to select one or more nodes
* Drag pan (hand mode): click and drag anywhere in the canvas to move around. When you're in this mode, you can only select one or more nodes by control/command + clicking directly on them

#### Zoom In / Zoom Out

Use:

* The + / – buttons
* Or pinch-to-zoom on a trackpad

***

## Working With Nodes

#### Adding Nodes

You can add nodes by clicking on the + connector coming out of a node and selecting from the displayed node options.

### Connecting, Disconnecting, and Reconnecting Nodes

* Connectors define the flow from one node to the next.
* Only valid connections are allowed — the builder prevents invalid links.
* When you hover over a connection, the builder highlights it in red and shows an 'x' icon. Click on the 'x' to delete a connector between two nodes.
* To reconnect a connection that you accidentally disconnected, click and drag a new connector from the output connector (diamond icon) of the first node and release on the input connector (rectangle icon) of the next node.

***

## Error Indicators

If something in your workflow needs attention, the builder surfaces it directly. This could be:

* Missing required configuration in a node
* Incorrect or incomplete properties
* Unconnected mandatory connectors
* Structural issues that prevent publishing

Problems appear as:

* A red warning triangle on the affected nodes
* A red output connectors when a node is missing an output These should help you quickly locate and resolve issues.

***

Once you’re comfortable with the builder layout and controls, the next step is learning each node type and how they work together to create a complete conversation flow.