https://github.com/bpm-crafters/process-engine-api
Beautiful implementation-agnostic process engine API.
https://github.com/bpm-crafters/process-engine-api
api process-engine process-engine-api
Last synced: about 2 months ago
JSON representation
Beautiful implementation-agnostic process engine API.
- Host: GitHub
- URL: https://github.com/bpm-crafters/process-engine-api
- Owner: bpm-crafters
- License: apache-2.0
- Created: 2024-01-11T14:26:27.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2025-11-19T13:49:09.000Z (4 months ago)
- Last Synced: 2025-11-19T15:34:54.261Z (4 months ago)
- Topics: api, process-engine, process-engine-api
- Language: Kotlin
- Homepage: https://bpm-crafters.github.io/process-engine-api-docs/snapshot/
- Size: 2.5 MB
- Stars: 16
- Watchers: 6
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Process Engine API
[](https://github.com/holisticon#open-source-lifecycle)
[](https://github.com/bpm-crafters/process-engine-api/actions/workflows/development.yml)
[](https://central.sonatype.com/artifact/dev.bpm-crafters.process-engine-api/process-engine-api)
## Purpose of the library
This library provides a modern engine-agnostic API which can be used to implement process applications. By providing a set
of adapters to relevant process engines (Camunda Platform 7, Camunda Platform 8, etc...) the library enforces separation of
the integration of process engine from the selection of the used engine. This approach fosters an easy migration between engines
and tries to achieve to support migrations with minimal (or even no) code modifications.
## API
The API consists of different parts independent of each other.
- Deployment API
- Decision Evaluation API
- Start Process API
- Correlation API
- Signal API
- Task Subscription API
- User Task Completion API
- User Task Modification API
- Service Task Completion API
## Helpful Components
- User Task Support
## Available Engine Adapters
If you want to try the API, please refer to one of the adapter implementations matching your infrastructure. For example:
- [Camunda Platform 7 Adapter](https://github.com/bpm-crafters/process-engine-adapters-camunda-7) [](https://central.sonatype.com/artifact/dev.bpm-crafters.process-engine-adapters/process-engine-adapter-camunda-platform-c7-root)
- [Camunda Platform 8 Adapter](https://github.com/bpm-crafters/process-engine-adapters-camunda-8) [](https://central.sonatype.com/artifact/dev.bpm-crafters.process-engine-adapters/process-engine-adapter-camunda-platform-c8-root)
- [CIB-Seven Adapter](https://github.com/bpm-crafters/process-engine-adapters-cib-seven) [](https://central.sonatype.org/artifact/dev.bpm-crafters.process-engine-adapters/process-engine-adapter-cib-seven-root)
## Process Engine Worker
If you are using the Process Engine API to provide workers using Spring Boot, there is a library with improved support for it:
- [Process Engine Worker](https://github.com/bpm-crafters/process-engine-worker) [
](https://central.sonatype.com/artifact/dev.bpm-crafters.process-engine-worker/process-engine-worker-root)
## Documentation
The API documentation can be found [here](https://bpm-crafters.github.io/process-engine-api/) or in its respective [repository](https://github.com/bpm-crafters/process-engine-api-docs).
## Anatomy
The library contains of the following Maven modules:
- `process-engine-api`: pure API written in Kotlin (100% Java-compatible)
- `process-engine-api-impl`: commons implementation, which is independent of the selected engine and can be used for adapter implementations.
## Contribution and Development
If you are missing a feature or found a bug, please [open an issue](https://github.com/bpm-crafters/process-engine-api/issues)
on this project and provide a pull request. If you have general questions, make sure to stop by our [discussions](https://github.com/orgs/bpm-crafters/discussions).