Mambu Flows
The Mambu Flows 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 Mambu Flows APIs enable you to run BPMN business logic alongside Mambu's Core Banking Engine (CBE) and third-party systems.
Process definitions encode your orchestration logic as BPMN files. Once uploaded and approved through the maker-checker workflow, a definition can be started through the Process Instances API or triggered from an external system.
API categories
| Category | Base path | Description |
|---|---|---|
| Destinations | /api/destinations | Manage named, reusable external HTTP endpoint registrations used by processes |
| Process Definitions | /api/processdefinitions | Upload BPMN files and manage the maker-checker approval workflow |
| Staged Process Definitions | /api/stagedprocessdefinitions | Manage process definitions pending maker-checker approval |
| Process Instances | /api/processinstances | Start, inspect, cancel, and search process instances |
| Process Executions | /api/processexecutions | Deliver callback messages to paused process executions. To query execution history, use the history endpoints of the Process Instances API (/api/processinstances/{processInstanceId}/history/...) |
| Process Tasks | /api/processtasks | Manage human tasks within running processes |
| Process Audit Log | /api/processauditlog | Query the audit trail for process activity |
How processes run
Mambu Flows processes are started via the Process Instances API and create persistent process instances. A process can finish within the start call or continue in the background, for example at a human task or while it waits for a callback (see Async execution). Processes are often 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 Mambu Flows section of 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 — five implementation patterns: sync HTTP, fire-and-forget async, inbound callback, human approval flow, and calling another process
In this section
- REST API Overview — base URL, required headers, authentication, error format, pagination, and rate limits common to all Mambu Flows endpoints.