Skip to main content
Version: Latest (4.52.0)

Flows

A flow is a set of components that perform predefined actions in a specific order as data travels through it. The data that travels between components we call messages.

When turned on a flow is set to an idle state, waiting for Trigger components to be triggered. When a component is triggered, the flow is considered to be running, as it is actively processing messages.

Because of the stateless nature of a flow, you need to restart the instance to stop it from further processing any messages.

note

You can also change any configuration at any time, even when it is actively processing messages, but beware that this might change the outcome of the flow and should not be done in a production scenario.

Flow toolbar​

Turns on/off a flow. A flow needs to be turned off in order to run it.

Flow variables​

Flow variables allow you to define variables within the scope of a flow and use them within component configurations using the variable syntax (%variableName%). More information on flow variables and how they can be created can be found in the configuration section.

Flow Notes​

The Flow Notes panel is designed to provide users with a convenient area to document important details, ideas, or instructions related to a flow. This section allows for quick note-taking and can be used to add any relevant information that helps in understanding or maintaining the flow.

  • You can use the double arrows to expand or shrink the Flow Notes panel.
Flow Notes

Console​

The console shows the log messages for the flow you are currently working on.

  • Hovering over the console will pause the refreshing and no new logs will be shown.

  • Clicking the name of the component in a log record will move the flow canvas to the component that created the record.

note

Clicking on a log record will open the log details window displayed below.

Logs (Showing last 4 messages)
  • : 2024-00-16 08:28:27 (Code- ilrg15rkn) This is an info message
  • : 2024-00-16 08:28:27 (Code- ilrg15rkn) This is a debug message
  • : 2024-00-16 08:28:27 (Code- ilrg15rkn) This is a warn message
  • : 2024-00-16 08:28:27 (Code- ilrg15rkn) This is an error message
Info button - Filters logs to only show info logs.
Log Details
Message:
This is an info message
Timestamp:
13/09/2024 13:45:52
Details:
"{}",

Starting a flow with a HTTP request​

Xill4 used to have a webhook component which would let you start a flow by means of an HTTP request. Xill4 now supports access to flows with HTTP requests natively. You can turn on and start a flow without accessing Xill4 from your browser by just sending a HTTP request. You will need the project ID and the flow ID to do this.
Send a request to the following endpoint:

POST /api/runners/

With body:

{
    "projectId": // project ID here,
    "flowId": // flow ID here,
    "environmentId": "default",
    "triggerId": // trigger ID here
}

The triggerId is optional. If you provide it, only that trigger component will send a message. If no triggerId if provided, the flow will only turn on and not trigger any trigger components.