Skip to main content
Version: 3.4.x


What is an integration?โ€‹

Integrations play a crucial role in connecting legacy systems or third-party applications to the

The fallback content to display on prerendering
. They enable seamless communication by leveraging custom code and the
The fallback content to display on prerendering
messaging system.

Integrations serve various purposes, including working with legacy APIs, implementing custom file exchange solutions, or integrating with RPAs.

High-level architectureโ€‹

Integrations involve interaction with legacy systems and require custom development to integrate them into your FLOWX.AI setup.

Developing a custom integrationโ€‹

Developing custom integrations for the

The fallback content to display on prerendering
is a straightforward process. You can use your preferred technology to write the necessary custom code, with the requirement that it can send and receive messages from the
The fallback content to display on prerendering

Steps to create a custom integrationโ€‹

Follow these steps to create a custom integration:

  1. Develop a microservice, referred to as a "Connector," using your preferred tech stack. The Connector should listen for Kafka events, process the received data, interact with legacy systems if required, and send the data back to Kafka.

  2. Configure the process definition by adding a message send action in one of the nodes. This action sends the required data to the Connector.

  3. Once the custom integration's response is ready, send it back to the FLOWX.AI engine. Keep in mind that the process will wait in a receive message node until the response is received.

For Java-based Connector microservices, you can use the following startup code as a quickstart guide:

ยปQuickstart connector

Managing an integrationโ€‹

Managing Kafka topicsโ€‹

It's essential to configure the engine to consume events from topics that follow a predefined naming pattern. The naming pattern is defined using a topic prefix and suffix, such as ""


The suggested naming convention is as follows:

package: "ai.flowx."
environment: "dev."
version: ".v1"
prefix: ${kafka.topic.naming.package}${kafka.topic.naming.environment}
suffix: ${kafka.topic.naming.version}
engineReceivePattern: engine.receive

pattern: ${kafka.topic.naming.prefix}${kafka.topic.naming.engineReceivePattern}*

Was this page helpful?