For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Type Alias: Job

Opt-In Subpath

The Effect API is an opt-in subpath (@camunda8/orchestration-cluster-api/effect) and requires the optional effect peer dependency. The main . entry stays Promise-based and pulls in zero Effect at runtime.

type Job = ActivatedJobResult;

A single activated job handed to an Effect handler. This is the raw activation payload (variables + custom headers + lifecycle keys); acknowledgement is driven by the value/error the handler's Effect produces, not by imperative methods.