vocabulary: 1.0.0
info:
  provider: Zeebe
  description: Vocabulary for Zeebe APIs.
  created: '2026-05-03'
  modified: '2026-05-03'
operational:
  apis:
    - name: Zeebe REST API
      namespace: zeebe-rest-api
      version: 8.6.0
      baseUrl: '{baseUrl}/v2'
      status: active
  resources:
    - name: topology
      methods:
        - get
    - name: deployments
      methods:
        - post
    - name: process-instances
      methods:
        - delete
        - post
    - name: jobs
      methods:
        - patch
        - post
    - name: messages
      methods:
        - post
    - name: signals
      methods:
        - post
    - name: incidents
      methods:
        - post
    - name: resources
      methods:
        - post
    - name: user-tasks
      methods:
        - post
  actions:
    - verb: get
      methods:
        - GET
    - verb: deploy
      methods:
        - POST
    - verb: create
      methods:
        - POST
    - verb: cancel
      methods:
        - DELETE
    - verb: migrate
      methods:
        - POST
    - verb: activate
      methods:
        - POST
    - verb: complete
      methods:
        - POST
    - verb: fail
      methods:
        - POST
    - verb: throw
      methods:
        - POST
    - verb: update
      methods:
        - PATCH
    - verb: publish
      methods:
        - POST
    - verb: broadcast
      methods:
        - POST
    - verb: resolve
      methods:
        - POST
    - verb: delete
      methods:
        - POST
    - verb: assign
      methods:
        - POST
  schemas:
    core:
      - ActivateJobsRequest
      - CreateProcessInstanceRequest
      - DeploymentResponse
      - Job
      - ProcessInstance
      - PublishMessageRequest
      - TopologyResponse
capability:
  workflows:
    - name: Zeebe Workflow
      file: capabilities/zeebe-workflow.yaml
      description: Unified workflow for Zeebe
      apis:
        - zeebe-rest-api
  personas:
    - id: developer
      name: Developer
      description: Integrates with Zeebe APIs