openapi: 3.1.0
info:
  title: Zeebe REST Cluster Signals API
  description: The Zeebe REST API provides endpoints for interacting with the Zeebe workflow engine that powers Camunda 8, including process deployment, instance management, job handling, and cluster topology queries.
  version: 8.6.0
  contact:
    name: Camunda
    url: https://camunda.com/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: '{baseUrl}/v2'
  description: Zeebe Gateway REST API
  variables:
    baseUrl:
      default: http://localhost:8080
security:
- BearerAuth: []
tags:
- name: Signals
paths:
  /signals/broadcast:
    post:
      operationId: broadcastSignal
      summary: Zeebe Broadcast a Signal
      description: Broadcasts a signal to all matching signal subscriptions.
      tags:
      - Signals
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - signalName
              properties:
                signalName:
                  type: string
                variables:
                  type: object
            examples:
              BroadcastSignalRequestExample:
                summary: Default broadcastSignal request
                x-microcks-default: true
                value:
                  signalName: Example Name
                  variables: {}
      responses:
        '204':
          description: Signal broadcast
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer