Skip to main content
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.

​
Active / Inactive

  • Determines whether the workflow is “live.”
  • Inactive workflows do not serve production traffic.
  • This toggle is clickable, allowing you to switch the status at any time
  • If workflow is Active, the last saved and published version is always the active one.

​
Public / Private

  • Public: Workflow is global — visible to all Breezers across all organizations.
  • Private: Restricted to your organization.

​
Version Selector

  • Displays the version you’re currently viewing.
  • Clicking opens a dropdown of all published versions.
  • Selecting one loads that specific version in the workflow builder.
  • Saving and Publishing always creates a new version, you cannot override an already existing version.
  • If workflow is Active, the last saved and published version is always the active one.
  • To revert to a previous version, you have to return to that version and Save & Publish it again. E.g., if you have a workflow with 5 versions and you want to revert to version 3, you can select version 3 from the Version dropdown, then click Save & Publish. This will create a new version (v6) that is identical to version 3.

​
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.
  • Does not make a real call.
  • Opens a test console in the bottom-right corner showing transcriptions and agent behaviors.
  • While testing, you’ll see End Test instead of Test/Call.

​
Call

Places a real outbound call through the selected phone number.
  • Opens a selector to choose which number to call and allows you to provide any workflow level inputs that are needed.
  • Hidden when the workflow is in draft mode.

​
Save & Publish

Saves your changes and creates a new numbered version. You must:
  • Provide a version name (required)
  • Optionally write a description
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.

​
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.
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.

​
Zoom In / Zoom Out

Use:
  • The + / – buttons
  • Or pinch-to-zoom on a trackpad

​
Panning

To move around the canvas:
  • Scroll anywhere to activate the mini-map in the bottom-right then click and drag inside the mini-map to move around the workflow.
  • Scroll horizontally or vertically 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.