Skip to main content

Process Orchestration

Non-Production Preview

The Process Orchestration APIs are currently available as a Non-Production Preview (NPP) feature, available to a limited number of customers. You should not process production data with NPP features. To request access, contact your Mambu Customer Success Manager. For more information, see Mambu Release Cycle — Feature Release Status.

The Process Orchestration APIs enable you to run BPMN business logic asynchronously alongside Mambu's Core Banking Engine (CBE) and third-party systems. This NPP release covers the External Orchestration pattern — processes triggered explicitly by external systems that run asynchronously and create persistent process instances.

Process definitions encode your orchestration logic as BPMN files. Once uploaded and approved through the maker-checker workflow, a definition can be started directly via the Process Executions API or triggered from an external system.

API categories

CategoryBase pathDescription
Destinations/api/destinationsManage named, reusable external HTTP endpoint registrations used by External Orchestration processes
Process Definitions/api/processdefinitionsUpload BPMN files and manage the maker-checker approval workflow
Staged Process Definitions/api/stagedprocessdefinitionsManage process definitions pending maker-checker approval
Process Instances/api/processinstancesStart, inspect, cancel, and search External Orchestration process instances
Process Executions/api/processexecutionsQuery execution history for External Orchestration processes
Process Tasks/api/processtasksManage human tasks within running External Orchestration processes
Process Audit Log/api/processauditlogQuery the audit trail for process activity

Orchestration pattern

This NPP release supports the External Orchestration pattern: BPMN processes that run asynchronously, outside a CBE request, and create persistent process instances. They are triggered explicitly via the Process Instances API and are used for long-running flows coordinated from external systems — for example, a loan origination flow from a mobile app, or a collections process initiated by a third-party platform.

User guide

For implementation guidance, tutorials, and worked examples, see the Process Orchestration user guide under Developer > Process Orchestration in the User Guide:

  • Getting Started — prerequisites, maker-checker model, and a complete quickstart tutorial
  • BPMN Authoring — full reference for service tasks, gateways, human tasks, async execution, and error handling
  • Worked Examples — four implementation patterns: sync HTTP, fire-and-forget async, inbound callback, and human approval flow

In this section

  • REST API Overview — base URL, required headers, authentication, error format, pagination, and rate limits common to all Process Orchestration endpoints.