Skip to main content

Flow Builder

The flow builder is a configuration interface in the dashboard for creating and managing step-by-step walkthroughs. Here you can define flow settings, add steps manually, or edit flows that were captured using the BreakGround Chrome Extension.

Builder Interface​

The builder uses a tabbed interface to organize configuration:

General Tab​

Configure basic settings and manage the flow's steps:

  • Basic Info -- Set the flow's name and description.
  • Frequency -- Control how often a flow appears to the same user:
    • Once -- Show the flow only the first time conditions are met.
    • Once per session -- Show the flow once per browser session.
    • Every time -- Show the flow each time conditions are met.
  • Steps -- Add, reorder, and configure individual steps.

Trigger Tab​

Define how the flow is initiated (e.g., URL Match). Set the specific URL patterns that should trigger the flow automatically, or choose Manual if the flow should only be triggered programmatically.

Targeting Tab​

Set audience rules to control which users see the flow based on user traits or behaviors. You can assign predefined audience segments or create custom rules inline.

Scheduling Tab​

Configure the active window for your flow. You can specify a start and end date to ensure the flow is only available during a specific period.

Managing Steps​

In the General tab, you can manage the individual steps that make up your flow. If you are creating a new flow, you can choose a template to start with predefined steps or build from scratch.

Adding and Reordering​

  1. Click Add Step to insert a new step into the flow.
  2. Choose a step type (Tooltip, Modal, Beacon, Navigation, etc.).
  3. Drag steps up or down using the handle to reorder them.

Configuring Steps​

Each step can be configured inline or linked to existing content. Available settings depend on the step type:

  • Target selector -- The CSS selector for the element this step attaches to.
  • Content -- Title, body, and embedded media (for inline content).
  • Position -- Where the step appears relative to the target element (top, bottom, left, right, auto).
  • Target URL -- Required for navigation steps.
  • Settings -- Step-specific options such as delay, custom input values, etc.
  • Use Existing Content -- Instead of defining content inline, you can select an existing Tooltip, Announcement, or Survey from your library.

Saving and Publishing​

  • Save -- Saves all changes to the flow. If the flow is new, it will remain in DRAFT status until published.
  • Publish -- Makes the flow active and available to users who match its trigger and targeting rules.
  • Unpublish -- Reverts a published flow back to draft status.