Camunda Signals API

The Signals API from Camunda — 1 operation(s) for signals.

OpenAPI Specification

camunda-signals-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Camunda 8 REST Cluster Signals API
  description: The Camunda 8 REST API provides endpoints for managing process instances, jobs, decisions, deployments, messages, signals, and other resources in the Camunda 8 process orchestration platform.
  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: Camunda 8 Self-Managed or SaaS
  variables:
    baseUrl:
      default: http://localhost:8080
security:
- BearerAuth: []
tags:
- name: Signals
paths:
  /signals/broadcast:
    post:
      operationId: broadcastSignal
      summary: Broadcast a signal
      description: Broadcasts a signal to all matching subscriptions.
      tags:
      - Signals
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - signalName
              properties:
                signalName:
                  type: string
                variables:
                  type: object
      responses:
        '204':
          description: Signal broadcast
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer