PHPackages laravolt/camunda - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. laravolt/camunda ActiveLibrary[API Development](/categories/api) laravolt/camunda ================ High level model, something like Eloquent, to interact with Camunda resources via REST API 2.7.0(7mo ago)2115.5k↓50%13[3 issues](https://github.com/laravolt/camunda/issues)1MITPHPPHP >=8.1 Since Jan 8Pushed 7mo ago4 watchersCompare [ Source](https://github.com/laravolt/camunda)[ Packagist](https://packagist.org/packages/laravolt/camunda)[ Docs](https://github.com/laravolt/camunda)[ RSS](/packages/laravolt-camunda/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (5)Versions (28)Used By (1) laravolt/camunda ================ [](#laravoltcamunda) Convenience Laravel HTTP client wrapper to interact with Camunda REST API. Installation ------------ [](#installation) `composer require laravolt/camunda` Configuration ------------- [](#configuration) Prepare your `.env`: ``` CAMUNDA_URL=http://localhost:8080/engine-rest #optional CAMUNDA_TENANT_ID= CAMUNDA_USER= CAMUNDA_PASSWORD= ``` Add following entries to `config/services.php`: ``` 'camunda' => [ 'url' => env('CAMUNDA_URL', 'https://localhost:8080/engine-rest'), 'user' => env('CAMUNDA_USER', 'demo'), 'password' => env('CAMUNDA_PASSWORD', 'demo'), 'tenant_id' => env('CAMUNDA_TENANT_ID', ''), ], ``` Usage ----- [](#usage) ### Process Definition [](#process-definition) ``` use Laravolt\Camunda\Http\ProcessDefinitionClient; $variables = ['title' => ['value' => 'Sample Title', 'type' => 'string']]; // Start new process instance $instance = ProcessDefinitionClient::start(key: 'process_1', variables: $variables); // Start new process instance with some business key $instance = ProcessDefinitionClient::start(key: 'process_1', variables: $variables, businessKey: 'somekey'); // Get BPMN definition in XML format ProcessDefinitionClient::xml(key: 'process_1'); ProcessDefinitionClient::xml(id: 'process_1:xxxx'); // Get all definition ProcessDefinitionClient::get(); // Get definitions based on some parameters $params = ['latestVersion' => true]; ProcessDefinitionClient::get($params); ``` Camunda API reference: ### Process Instance [](#process-instance) ``` use Laravolt\Camunda\Http\ProcessInstanceClient; // Find by ID $processInstance = ProcessInstanceClient::find(id: 'some-id'); // Get all instances ProcessInstanceClient::get(); // Get instances based on some parameters $params = ['businessKeyLike' => 'somekey']; ProcessInstanceClient::get($params); ProcessInstanceClient::variables(id: 'some-id'); ProcessInstanceClient::delete(id: 'some-id'); ``` Camunda API reference: ### Message Event [](#message-event) ``` use Laravolt\Camunda\Http\MessageEventClient; // Start processinstance with message event // Required // messageName : message event name // businessKey : Busniess key for process instance // Rerturn Process insntance from message event MessageEventClient::start(messageName: "testing", businessKey: "businessKey") ``` ### Task [](#task) ``` use Laravolt\Camunda\Http\TaskClient; $task = TaskClient::find(id: 'task-id'); $tasks = TaskClient::getByProcessInstanceId(id: 'process-instance-id'); $tasks = TaskClient::getByProcessInstanceIds(ids: 'arrayof-process-instance-ids'); TaskClient::submit(id: 'task-id', variables: ['name' => ['value' => 'Foo', 'type' => 'String']]); // will return true or false $variables = TaskClient::submitAndReturnVariables(id: 'task-id', variables: ['name' => ['value' => 'Foo', 'type' => 'String']]) // will return array of variable // Claim a Task $tasks = TaskClient::claim($task_id, $user_id); // Unclaim a Task $tasks = TaskClient::unclaim($task_id); // Assign a Task $tasks = TaskClient::assign($task_id, $user_id); ``` Camunda API reference: ### External Task [](#external-task) ``` use Laravolt\Camunda\Http\ExternalTaskClient; $topics = [ ['topicName' => 'pdf', 'lockDuration' => 600_000] ]; $externalTasks = ExternalTaskClient::fetchAndLock('worker1', $topics); foreach ($externalTasks as $externalTask) { // do something with $externalTask // Mark as complete after finished ExternalTaskClient::complete($externalTasks->id); } // Unlock some task ExternalTaskClient::unlock($task->id) // Get task locked $externalTaskLocked = ExternalTaskClient::getTaskLocked(); ``` Camunda API reference: ### Consume External Task [](#consume-external-task) Create a new job to consume external task via `php artisan make:job ` and modify the skeleton: ``` use Laravolt\Camunda\Dto\ExternalTask; use Laravolt\Camunda\Http\ExternalTaskClient; public function __construct( public string $workerId, public ExternalTask $task ) { } public function handle() { // Do something with $this->task, e.g: get the variables and generate PDF $variables = \Laravolt\Camunda\Http\ProcessInstanceClient::variables($this->task->processDefinitionId); // PdfService::generate() // Complete the task $status = ExternalTaskClient::complete($this->task->id, $this->workerId); } ``` Subscribe to some topic: ``` // AppServiceProvider.php use Laravolt\Camunda\Http\ExternalTaskClient; public function boot() { ExternalTaskClient::subscribe('pdf', GeneratePdf::class); } ``` Register the scheduler: ``` // app/Console/Kernel.php protected function schedule(Schedule $schedule) { $schedule->command('camunda:consume-external-task --workerId=worker1')->everyMinute(); } ``` If you need shorter pooling time (sub-minute frequency), please check [Laravel Short Schedule](https://github.com/spatie/laravel-short-schedule). Reference: - - - ### Task History (Completed Task) [](#task-history-completed-task) ``` use Laravolt\Camunda\Http\TaskHistoryClient; $completedTask = TaskHistoryClient::find(id: 'task-id'); $completedTasks = TaskHistoryClient::getByProcessInstanceId(id: 'process-instance-id'); ``` Camunda API reference: ### Deployment [](#deployment) ``` use Laravolt\Camunda\Http\DeploymentClient; // Deploy bpmn file(s) DeploymentClient::create('test-deploy', '/path/to/file.bpmn'); DeploymentClient::create('test-deploy', ['/path/to/file1.bpmn', '/path/to/file2.bpmn']); // Get deployment list DeploymentClient::get(); // Find detailed info about some deployment DeploymentClient::find($id); // Truncate (delete all) deployments $cascade = true; DeploymentClient::truncate($cascade); // Delete single deployment DeploymentClient::delete(id: 'test-deploy', cascade: $cascade); ``` ### Raw Endpoint [](#raw-endpoint) You can utilize `Laravolt\Camunda\CamundaClient` to call any Camunda REST endpoint. ``` use Laravolt\Camunda\CamundaClient; $response = CamundaClient::make()->get('version'); echo $response->status(); // 200 echo $response->object(); // sdtClass echo $response->json(); // array, something like ["version" => "7.14.0"] ``` > `CamundaClient::make()` is a wrapper for [Laravel HTTP Client](https://laravel.com/docs/master/http-client) with base URL already set based on your Camunda services configuration. Take a look at the documentation for more information. ### Health Score 52 — FairBetter than 96% of packages Maintenance61 Regular maintenance activity Popularity37 Limited adoption so far Community21 Small or concentrated contributor base Maturity76 Established project with proven stability Bus Factor1 Top contributor holds 71.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~84 days Recently: every ~118 days Total 26 Last Release 218d ago Major Versions 1.1.4 → 2.0.02021-05-23 PHP version history (3 changes)1.0.0PHP >=7.3 2.0.0PHP >=8.0 2.6.0PHP >=8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/db6f5ab11fb203026beb0e298930cc5a07080022e7cbb4c597b97321585df61b?d=identicon)[uyab](/maintainers/uyab) --- Top Contributors [![uyab](https://avatars.githubusercontent.com/u/149716?v=4)](https://github.com/uyab "uyab (91 commits)")[![purwadarozatun](https://avatars.githubusercontent.com/u/8139599?v=4)](https://github.com/purwadarozatun "purwadarozatun (22 commits)")[![qisthidev](https://avatars.githubusercontent.com/u/34129273?v=4)](https://github.com/qisthidev "qisthidev (8 commits)")[![faderik](https://avatars.githubusercontent.com/u/55375390?v=4)](https://github.com/faderik "faderik (2 commits)")[![marshallia](https://avatars.githubusercontent.com/u/12694360?v=4)](https://github.com/marshallia "marshallia (2 commits)")[![rizqi-111](https://avatars.githubusercontent.com/u/58018241?v=4)](https://github.com/rizqi-111 "rizqi-111 (2 commits)") --- Tags camundalaravel-packagephprest-apiworkflowlaravellaravoltcamunda ### Embed Badge ![Health badge](/badges/laravolt-camunda/health.svg) ``` [![Health](https://phpackages.com/badges/laravolt-camunda/health.svg)](https://phpackages.com/packages/laravolt-camunda) ``` ### Alternatives [openai-php/laravel OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API 3.7k7.6M74](/packages/openai-php-laravel)[moe-mizrak/laravel-openrouter Laravel package for OpenRouter (A unified interface for LLMs) 153107.2k2](/packages/moe-mizrak-laravel-openrouter)[scriptdevelop/whatsapp-manager Paquete para manejo de WhatsApp Business API en Laravel 762.6k](/packages/scriptdevelop-whatsapp-manager)[njoguamos/laravel-plausible A laravel package for interacting with plausible analytics api. 208.8k](/packages/njoguamos-laravel-plausible) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)