Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zeebe Jobs API

The Jobs API from Zeebe — 5 operation(s) for jobs.

Zeebe Jobs API is one of 9 APIs that Zeebe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 8.6.0.

Requests are made against a single base URL, {baseUrl}/v2.

5 operations 5 paths 2 schemas 1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
8.6.0
Base URL
https://{region}.zeebe.camunda.io:443/{clusterId}/v2
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

Zeebe Jobs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 5
POST
/jobs/activation
Zeebe Activate Jobs
activateJobs body → 200
POST
/jobs/{jobKey}/completion
Zeebe Complete a Job
completeJob 1 param body → 204
POST
/jobs/{jobKey}/failure
Zeebe Fail a Job
failJob 1 param body → 204
POST
/jobs/{jobKey}/error
Zeebe Throw Error for a Job
throwError 1 param body → 204
PATCH
/jobs/{jobKey}/retries
Zeebe Update Job Retries
updateJobRetries 1 param body → 204

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Job (13 properties), ActivateJobsRequest (6 properties). Each schema is shown below with its type and property counts.

Job
object
13 properties
ActivateJobsRequest
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeebe-jobs-api-openapi.yml Raw ↑

Other APIs Zeebe publishes across the network.

Zeebe Cluster API
Zeebe Deployments API
Zeebe Incidents API
Zeebe Messages API
Zeebe Process Instances API
Zeebe Resources API
Zeebe Signals API
Zeebe User Tasks API