Zeebe · JSON Structure

Zeebe Api Publish Message Request Structure

PublishMessageRequest schema from Zeebe REST API

Type: object Properties: 6 Required: 2
BPMNCamundaCloud NativeDistributed SystemsJavaMicroservicesProcess AutomationWorkflow Orchestration

PublishMessageRequest is a JSON Structure definition published by Zeebe, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name correlationKey timeToLive messageId variables tenantId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/json-structure/zeebe-api-publish-message-request-structure.json",
  "name": "PublishMessageRequest",
  "description": "PublishMessageRequest schema from Zeebe REST API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "Example Name"
    },
    "correlationKey": {
      "type": "string",
      "example": "example-value"
    },
    "timeToLive": {
      "type": "int64",
      "example": 100
    },
    "messageId": {
      "type": "string",
      "example": "500123"
    },
    "variables": {
      "type": "object",
      "example": {}
    },
    "tenantId": {
      "type": "string",
      "example": "500123"
    }
  },
  "required": [
    "name",
    "correlationKey"
  ]
}