Process Orchestration REST API Guide

Base URL

All Process Orchestration API calls are made against your tenant's Mambu instance, the same base URL used by the rest of the Mambu v2 API:

https://<tenant>.mambu.com/api

Relative paths in this reference omit the base URL. For example, /destinations means https://<tenant>.mambu.com/api/destinations.

Content-Type and Accept headers

All requests must include the following headers:

Header	Value	Notes
Accept	application/vnd.mambu.v2+json	Required for all requests
Content-Type	application/json	For JSON request bodies (POST, PUT)
Content-Type	application/octet-stream	For binary file uploads (BPMN/DMN deploy)

Authentication

All endpoints require HTTP Basic authentication. Provide your Mambu API credentials (username and password) with every request.

GET /api/destinations
Accept: application/vnd.mambu.v2+json
Authorization: Basic <base64-encoded username:password>

Requests without valid credentials return 401 Unauthorized.

For maker-checker endpoints (approve or reject staged definitions), the approving user's credentials must differ from the submitting user's credentials. Attempting self-approval returns 422 Unprocessable Entity.

Error format

All error responses use the standard Mambu error envelope:

{
  "errors": [
    {
      "errorCode": 3,
      "errorSource": "reviewedBy",
      "errorReason": "approver must differ from submitter"
    }
  ]
}

Field	Type	Description
errorCode	integer	Mambu internal error code
errorSource	string	The field or system component that caused the error
errorReason	string	Human-readable description of the error

Common HTTP status codes used across the Process Orchestration API:

Status	Meaning
200 OK	Successful GET or action
201 Created	Resource created (POST)
204 No Content	Successful DELETE
400 Bad Request	Invalid request body or parameters
401 Unauthorized	Missing or invalid credentials
403 Forbidden	Authenticated but not authorised for this operation
404 Not Found	Resource does not exist
422 Unprocessable Entity	Business rule violation (for example, self-approval or wrong state)

Pagination

List endpoints follow standard Mambu pagination. Use offset and limit query parameters to page through results:

GET /api/destinations?offset=0&limit=50
Accept: application/vnd.mambu.v2+json
Authorization: Basic <base64-encoded username:password>

Default and maximum page sizes follow the standard Mambu API limits documented in the core platform API reference.

Rate limits

Process Orchestration endpoints share the standard Mambu API rate limits. Excessive requests return 429 Too Many Requests. Implement exponential back-off when retrying.