Deployment guidelines v5.6.0

After upgrading to a new platform version, always ensure that your installed component versions match the versions specified in the release notes. To verify this, navigate to FlowX.AI Designer > Platform Status.

Component versions

Component	5.6.0	5.5.0	5.4.0	5.3.0	5.2.0	5.1.1
process-engine	10.77.0	10.60.0	10.38.0	10.29.0	10.12.0	9.64.3
admin	10.66.0	10.53.0	10.38.0	10.26.1	10.12.0	9.66.5
designer	10.127.3	10.91.0	10.59.1	10.32.4	10.12.1	9.159.5
cms-core	10.43.0	10.35.0	10.22.0	10.16.0	10.7.0	9.36.3
scheduler-core	10.31.0	10.25.0	10.15.0	10.11.1	10.4.1	9.26.1
events-gateway	10.33.1	10.27.0	10.17.0	10.12.1	10.4.1	9.26.1
notification-plugin	10.42.1	10.35.0	10.22.0	10.17.0	10.7.0	9.29.1
document-plugin	10.46.0	10.35.0	10.23.0	10.16.0	10.6.0	9.35.1
task-management-plugin	10.41.1	10.35.0	10.25.0	10.18.0	10.7.0	9.34.2
data-search	10.30.1	10.25.0	10.14.0	10.10.1	10.4.1	9.23.1
audit-core	10.40.0	10.31.0	10.21.0	10.15.1	10.6.0	9.30.1
advancing-controller	10.33.1	10.27.0	10.16.0	10.11.0	10.4.1	9.25.1
integration-designer	10.84.0	10.63.0	10.38.0	10.24.0	10.8.0	9.50.0
application-manager	10.69.1	10.53.0	10.37.0	10.24.0	10.11.0	9.73.6
runtime-manager	10.69.1	10.53.0	10.37.0	10.24.0	10.11.0	9.73.6
data-sync	10.38.0	10.31.1	10.20.1	10.14.1	10.3.1	9.22.1
authorization-system	10.51.0	10.42.1	10.28.0	10.18.1	10.7.0	9.34.2
nosql-db-runner	10.34.0	10.27.0	10.17.0	10.10.1	10.4.1	9.22.1
email-gateway	10.32.1	10.24.0	10.9.0	-	-	-
organization-manager	10.26.1	10.19.2	-	-	-	-
webhook-gateway	10.1.1	-	-	-	-	-

Embedded components

• SpiceDB
• DGraph

Renderers

Component	5.6.0	5.5.0	5.4.0	5.3.0	5.2.0	5.1.1
@flowx/angular-sdk	10.127.3	10.68.0	10.59.1	10.32.4	10.12.1	9.159.5
@flowx/angular-theme	10.127.3	10.68.0	10.59.1	10.32.4	10.12.1	9.159.5
@flowx/angular-ui-toolkit	10.127.3	10.68.0	10.59.1	10.32.4	10.12.1	9.159.5
@flowx/react-sdk	10.127.3	10.68.0	10.59.1	10.32.4	10.12.1	9.159.5
@flowx/react-theme	10.127.3	10.68.0	10.59.1	10.32.4	10.12.1	9.159.5
@flowx/react-ui-toolkit	10.127.3	10.68.0	10.59.1	10.32.4	10.12.1	9.159.5
@flowx/core-sdk	10.127.3	10.68.0	10.59.1	10.32.4	10.12.1	9.159.5
@flowx/core-theme	10.127.3	10.68.0	10.59.1	10.32.4	10.12.1	9.159.5
iOS renderer	10.3.0	10.3.0	10.2.0	10.1.0	10.0.0	9.0.5
Android renderer	10.3.0	10.3.0	10.2.0	10.1.0	10.0.0	9.0.3

Plugins

Component	5.6.0	5.5.0	5.4.0	5.3.0	5.2.0	5.1.1
ocr-plugin	1.0.17	1.0.17	1.0.17	1.0.17	1.0.17	1.0.17
reporting-plugin	0.2.3	0.2.3	0.2.3	0.2.3	0.2.3	0.2.3

AI Platform

Component	5.6.0	5.5.0	5.4.0	5.3.0	5.2.0	5.1.1
ai-assistant	10.2.3	10.1.2	10.1.2	10.1.1	10.0.1	9.2.5
di-platform	10.3.0	10.2.6	10.2.5	10.2.5	10.2.0	9.3.1
ai-platform-ai-developer	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
ai-platform-connected-graph	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
ai-platform-knowledge-graph	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
ai-platform-agents	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
ai-platform-conversations	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
ai-platform-models	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
ai-platform-tenants	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
ai-platform-planner	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
ai-platform-ai-analyst	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
ai-platform-ai-designer	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
ai-platform-agent-builder	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
ai-platform-binaries	10.6.0	TBD	10.1.3	10.1.3	10.0.1	9.4.2
knowledgebase	10.6.0	TBD	-	-	-	-
knowledgebase-rag	10.6.0	10.2.0	-	-	-	-
knowledgebase-indexer-v2	10.6.0	10.2.0	-	-	-	-
mcp	10.6.0	10.2.0	-	-	-	-
doc-converter	10.2.2	-	-	-	-	-
doc-parser	10.5.1	-	-	-	-	-

New in 5.6.0: webhook-gateway is a new microservice for processing incoming webhooks. It handles webhook event ingestion and routing to process instances.

Third-party supported component versions

FlowX.AI Version	3rd Party Dependency	Supported Versions
5.6.0	Keycloak	26+
5.6.0	Kafka	3.8 - 3.9
5.6.0	PostgreSQL	16 - 17
5.6.0	Oracle Database	21c, 23ai
5.6.0	MongoDB	7 - 8
5.6.0	Redis	7.4 - 8.0
5.6.0	Angular (Web SDK)	20
5.6.0	React (Web SDK)	18.x

Starting FlowX 5.0, the following versions of 3rd Party Dependencies are no longer supported:

• Keycloak versions older than 26
• Kafka versions older than 3.8
• Redis versions older than 7.4

New in v5.6.0

Key features and updates

Chat Driven Workflows

Multi-turn AI conversations with session memory and intent classification

Incoming Webhooks

Trigger processes from external HTTP POST requests via the new webhook-gateway service

Web Page Extractor

Collect readable content from web page URLs with crawling and link following

Proxy Server Connections

Route integration traffic through HTTP/HTTPS proxy servers

UI Flow Route Management

Query parameters, route maps, and breadcrumb navigation for UI Flows

MCP Authentication

BEARER and BASIC auth for MCP server connections

Upgrading from v5.5.0

Breaking changes

WorkspaceCreatedEvent ownership change

The WorkspaceCreatedEvent Kafka topic ownership has moved from authorization-system to organization-manager.

What changed:

• organization-manager now produces WorkspaceCreatedEvent messages
• authorization-system no longer produces these events
• Update your Kafka topic ACLs if you manage topic-level permissions

---

gRPC thread pool configuration

The default gRPC client thread pool sizes in AI Platform have been updated. Review your deployment configuration if you have custom thread pool settings.

---

New environment variables

Integration Designer

Environment Variable	Description	Default Value	Component
FLOWX_WEBHOOKS_BASE_URL	Base URL for webhook-gateway service communication	http://webhook-gateway:80	integration-designer
FLOWX_WEB_CRAWLER_BASE_URL	Base URL for the web-crawler service (Web Page Extractor node)	http://web-crawler:80	integration-designer

NoSQL DB Runner

Environment Variable	Description	Default Value	Component
FLOWX_MONGO_CONNECTIONS_CACHE_MAX_ENTRIES	Maximum number of cached external MongoDB connections	100	nosql-db-runner
FLOWX_MONGO_CONNECTIONS_CACHE_TTL	Time-to-live for cached external MongoDB connections	1d	nosql-db-runner

Process Engine

Environment Variable	Description	Default Value	Component
FLOWX_RETRY_MAX_RETRIES	Maximum retry attempts for failed operations	9	process-engine
FLOWX_RETRY_BASE_DELAY_MS	Base delay between retries (ms)	10	process-engine
FLOWX_RETRY_MAX_DELAY_MS	Maximum delay between retries (ms)	200	process-engine

Authorization System

Environment Variable	Description	Default Value	Component
SPRING_LIQUIBASE_PARAMETERS_DEFAULT_REALM_ADMIN_INITIAL_PASSWORD	Initial password for default realm admin user	(none)	authorization-system
SPRING_LIQUIBASE_PARAMETERS_DEFAULT_REALM_ADMIN_INITIAL_PASSWORD_IS_TEMPORARY	Force password change on first login	true	authorization-system

Application Manager

Environment Variable	Description	Default Value	Component
FLOWX_APPLICATION_MERGE_RESOURCES_PROXY_CONNECTION_RESOURCE_ID_FIELD	Resource ID field for proxy connection merge	resourceId	application-manager
FLOWX_APPLICATION_MERGE_RESOURCES_PROXY_CONNECTION_FLATTENMAP_ID_FIELDS	Flatten map ID fields for proxy connection merge	resourceId, name	application-manager
FLOWX_APPLICATION_MERGE_RESOURCES_PROXY_CONNECTION_FLATTENMAP_EXCLUDED_JSON_PATHS	Excluded JSON paths for proxy connection flatten map	authorization.configuration	application-manager
FLOWX_APPLICATION_MERGE_RESOURCES_PROXY_CONNECTION_COMPARE_REMOVED_JSON_PATHS	Excluded JSON paths when comparing removed proxy connections	resourceId, resourceDefinitionId	application-manager
FLOWX_APPLICATION_MERGE_RESOURCES_PROXY_CONNECTION_CONFLICT_EXCLUDED_JSON_PATHS	Excluded JSON paths for proxy connection conflict detection	resourceId, resourceDefinitionId	application-manager

Data Search

Environment Variable	Description	Default Value	Component
FLOWX_SPICEDB_HOST	SpiceDB server hostname	spicedb	data-search
FLOWX_SPICEDB_PORT	SpiceDB server port	50051	data-search
FLOWX_SPICEDB_TOKEN	SpiceDB authentication token	- (required)	data-search
FLOWX_LIB_CAS_CLIENT_SERVICES_AUTHORIZATION_SYSTEM_BASE_URL	Authorization system base URL for CAS client	http://authorization-system:80	data-search

Email Gateway

Environment Variable	Description	Default Value	Component
FLOWX_SPICEDB_HOST	SpiceDB server hostname	spicedb	email-gateway
FLOWX_SPICEDB_PORT	SpiceDB server port	50051	email-gateway
FLOWX_SPICEDB_TOKEN	SpiceDB authentication token	- (required)	email-gateway
FLOWX_LIB_CAS_CLIENT_SERVICES_AUTHORIZATION_SYSTEM_BASE_URL	Authorization system base URL for CAS client	http://authorization-system:80	email-gateway

The SpiceDB and CAS client variables for data-search and email-gateway are required for authorization integration. These services now use the same SpiceDB-based authorization as other platform services.

Webhook Gateway

Environment Variable	Description	Default Value	Component
SPRING_DATASOURCE_URL	JDBC connection URL for webhook registrations database	jdbc:postgresql://postgresql:5432/webhook_gateway	webhook-gateway
SPRING_DATASOURCE_USERNAME	Database username	flowx	webhook-gateway
SPRING_DATASOURCE_PASSWORD	Database password	(required)	webhook-gateway
SECURITY_OAUTH2_BASE_SERVER_URL	OAuth2/OIDC server base URL	—	webhook-gateway
SECURITY_OAUTH2_REALM	OAuth2 realm name	—	webhook-gateway
SECURITY_OAUTH2_SERVICE_ACCOUNT_ADMIN_CLIENT_ID	Service account client ID	flowx-webhook-gateway-sa	webhook-gateway
SECURITY_OAUTH2_SERVICE_ACCOUNT_ADMIN_CLIENT_SECRET	Service account client secret	(required)	webhook-gateway
KAFKA_TOPIC_PROCESS_START_OUT	Kafka topic for process start events	ai.flowx.core.trigger.start-for-event.process.v1	webhook-gateway

webhook-gateway is a new microservice in 5.6.0. It requires its own PostgreSQL database (webhook_gateway), Kafka access, Keycloak service account (flowx-webhook-gateway-sa), and SpiceDB connectivity.

---

New Kafka topics

Document Plugin

New topic for UI Flow session document persistence.

Topic Name	Description	Direction
ai.flowx.plugin.document.trigger.persist.document.session.v1	Triggers UI Flow session document persistence; result delivered via SSE through events-gateway	Inbound
ai.flowx.eventsgateway.receive.document.v1	Document events sent to events-gateway for SSE delivery	Outbound

Webhook Gateway Kafka topics

Topic Name	Description	Direction
ai.flowx.core.trigger.start-for-event.process.v1	Triggers process starts from incoming webhook events	Outbound

The Webhook Gateway is a producer-only service — it receives HTTP webhook requests and publishes process start events to Kafka. It does not consume from any Kafka topics.

UI flow session variable updates

New topic for propagating document upload results and workflow completion results to the process-engine, which updates UI flow session variables.

Topic Name	Description	Direction
ai.flowx.core.trigger.ui-flow.update.v1	UI flow session variable updates after document upload or workflow completion	Inbound (process-engine) / Outbound (document-plugin, integration-designer)

Environment Variable	Description	Default Value	Component
KAFKA_TOPIC_UIFLOW_UPDATE_IN	Topic for receiving UI flow session variable updates	ai.flowx.core.trigger.ui-flow.update.v1	process-engine
KAFKA_TOPIC_UIFLOW_UPDATE_OUT	Topic for sending UI flow session variable updates	ai.flowx.core.trigger.ui-flow.update.v1	document-plugin, integration-designer
KAFKA_CONSUMER_GROUPID_PROCESS_UIFLOWUPDATE	Consumer group ID for UI flow updates	ui-flow-update	process-engine
KAFKA_CONSUMER_THREADS_PROCESS_UIFLOWUPDATE	Number of consumer threads for UI flow updates	6	process-engine

---

Compatibility

• SpiceDB: Now required for data-search and email-gateway in addition to existing services
• Renderer Updates: Web and mobile SDKs include route management, start parameters, enum label display, and chat enhancements
• Database: The start_params column on ui_flow_session table has been renamed to variables (auto-migrated via Liquibase). The column now stores all session variables, including start parameters and updates from document uploads and workflow completions

Support

For technical support, deployment assistance, or feature questions, please contact your FlowX.AI support representative.

Support channels

• Technical issues: Contact your FlowX.AI support representative
• Feature questions: Reach out through your designated support channel
• Documentation: Report documentation issues or suggestions