Skip to main content

API

Expose and consume services via a REST API

Integrates easily with external systems, frontend UI’s, CI/CD pipelines and notification services

Fluxnova provides a modern, secure API layer to support seamless integration and operational transparency.

Fluxnova APIs make it easy to connect business workflows to your existing digital landscape, enabling true end to end automation

Get started by visiting our REST API documentation

Modeler Shape Editor
API config

Insights

  • A fully documented REST API enables external systems to deploy workflows, trigger processes, complete tasks and retrieve real time status
  • Java based SDKs allow developers to embed Fluxnova functionality directly into their applications or services
  • Supports querying of process history, user task management, decision execution and event correlation through simple API calls
  • Extensible by design, plug in connectors, scripts or service tasks to integrate with databases, messaging systems or legacy tools

API Examples

Start a Process Instance

Endpoint:

POST /engine-rest/process-definition/key/{key}/start

  • {key} is the process definition key (not the ID)
  • This endpoint starts a new instance of the process definition

Headers:

Content-Type: application/json

Code Example In Demo Environment

POST https://demo.fluxnova.finos.org/engine-rest/process-definition/key/Process_0kzrpyy/start
Content-Type: application/json
{
"businessKey": "my-business-key-001"
}
Response Body

{
"id": "72bf0249-a94a-11f0-90d2-0a2c3439e846",
"definitionId": "Process_0kzrpyy:1:83cf1c26-a8e9-11f0-90d2-0a2c3439e846",
"businessKey": "my-business-key-001",
"caseInstanceId": null,
"ended": false,
"suspended": false,
"tenantId": null,
"definitionKey": "Process_0kzrpyy"
}

Get Process Instance Data

Endpoint:

GET /engine-rest/process-instance/{id}

  • Replace {id} with the actual process instance ID.

Headers:

Content-Type: application/json

Code Example In Demo Environment

GET https://demo.fluxnova.finos.org/engine-rest/process-instance/734790e5-a946-11f0-90d2-0a2c3439e846
Content-Type: application/json
Response Body

{
"id": "734790e5-a946-11f0-90d2-0a2c3439e846",
"definitionId": "Process_0kzrpyy:1:83cf1c26-a8e9-11f0-90d2-0a2c3439e846",
"businessKey": "my-business-key-001",
"caseInstanceId": null,
"ended": false,
"suspended": false,
"tenantId": null,
"definitionKey": "Process_0kzrpyy"
}

Update Process Instance Variables

Endpoint:

POST /engine-rest/process-instance/{id}/variables

  • Replace {id} with the actual process instance ID.

Headers:

Content-Type: application/json

Code Example In Demo Environment

POST https://demo.fluxnova.finos.org/engine-rest/process-instance/734790e5-a946-11f0-90d2-0a2c3439e846/variables
Content-Type: application/json
{
"approvalStatus": { "value": "approved", "type": "String" }
}

Get Process Instance Updated Variable Data

Endpoint:

GET /engine-rest/process-instance/{id}/variables

  • Replace {id} with the actual process instance ID.

Headers:

Content-Type: application/json

Code Example In Demo Environment

GET https://demo.fluxnova.finos.org/engine-rest/process-instance/734790e5-a946-11f0-90d2-0a2c3439e846/variables
Content-Type: application/json
Response Body

{
"amount": {
"type": "Integer",
"value": 1000,
"valueInfo": {}
},
"invoiceId": {
"type": "String",
"value": "A123",
"valueInfo": {}
}
}