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 Messages API

The Messages API from Zeebe — 1 operation(s) for messages.

Zeebe Messages 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 Messages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 8.6.0.

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

1 operations 1 paths 1 schemas 1 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 Messages API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Messages 1
POST
/messages/publication
Zeebe Publish a Message
publishMessage body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is PublishMessageRequest (6 properties). Each schema is shown below with its type and property counts.

PublishMessageRequest
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeebe-messages-api-openapi.yml Raw ↑

Other APIs Zeebe publishes across the network.

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