Flows

The Flows page lists every flow deployed for your organization.

Navigate to the Heartbeat Console and select Flows from the left-navigation menu.

Headless flows are always part of a larger message processing pipeline, and they do not have separate message processing metrics. By default they do not appear in the main list, but they are visible as "downstream flows" on the details pages of the flows that use them.

To view headless flows, select Show Headless Flows.

Groups

You can optionally assign a group identifier in the flow spec to group flows on this page. Select the group icon () in the top-right corner to switch to group view.

The flow list is grouped by default, main integration, and Beatbox flows.

Flows without an assigned group are listed under "default". Flows deployed from a Beatbox installation are grouped by the name provided when creating the Beatbox ID.

Beatbox flows appear on this page only if you create an Utilihive Agent user and include its credentials in the beatbox.env file.

Flow Details

Select a flow from the list to open its details page. The details page shows the flow’s current status, configuration, and flow access across multiple tabs.

The console displays a single flow’s total count of in-flight, complete, and failed messages.

Disable Flows

You can temporarily disable a flow while investigating issues or performing maintenance.

The disable and enable buttons are available only when the flowControl feature flag is enabled in your values.yaml configuration. By default, the feature flag is disabled, and the buttons are hidden. 
  features.js: |
      window = window || {};
      window.features = {
          flowControl: true
      };

To disable a flow with a REST, SOAP, or handoff source, open the flow page and select Disable in the top-right corner. Provide a reason for disabling the flow. Other users can see this reason. The following image shows a disabled flow:

The flow page displays a banner that the flow is disabled, including who disabled it and why.

When a flow is disabled, REST API endpoints return a 503 status with the following payload:

{
  "message": "Request rejected because the endpoint has been disabled."
}

To resume the flow and remove the warning, select Enable in the top-right corner.

Flow Spec

Select the Flow Spec tab to review a flow’s specification. Use the button on the right side of the page to change the view:

Button Description

Coding brackets.

A visual low-code view of the flow specification with sections that you can expand and collapse.
The Flow spec tab shows details about the flow’s configuration and processors.

Documentation

If the flow exposes a REST API, its OpenAPI resource is converted into a testable UI and the Documentation tab appears. The following image shows what this tab looks like:

The Documentation tab displays a POST endpoint for a REST API.

Use the documentation interface to view and test OpenAPI schemas directly in the browser. Expand an HTTP request type, such as POST, to show the parameters, expected request body, and possible responses, as shown in the following image:

The expanded POST request displays an example request body in JSON format.

Select Try it out, and then select Send to send a request to the endpoint. The following image shows a POST request that returned a 401 status:

The page displays the curl command that ran the POST request and the returned 401 Unauthorized message.

To use Try it out, complete the following steps:

  1. Create a Connect service account.

  2. Grant the service account access to this flow.

  3. Select Authorize and enter the service account credentials.

For steps on how to create and manage service accounts, see Flow access.

The Authorize button appears only if the OpenAPI schema includes the securitySchemes object. If your schema does not define security, the button is not shown and you cannot authorize from the Documentation tab. In that case, test the endpoints using an API client such as Postman or curl with the service account credentials.

Flow Access

Flow Access displays a list of the Connect Service Accounts that have access to this flow.

For more information on Connect Service Accounts and how to create and manage access to flows, see Service accounts. To troubleshoot access issues, see Flow access troubleshooting.