Broadcast signal

POST 
/signals/broadcast

Broadcasts a signal.

Request

application/json

Body

required

signalName stringrequired

The name of the signal to broadcast.

variables object

The signal variables as a JSON object.

property name* any

Additional properties allowed.

tenantId string

The ID of the tenant that owns the signal.

Responses

200

The signal was broadcast.

application/json

Schema

Schema

tenantId string

The tenant ID of the signal that was broadcast.

signalKey string

The unique ID of the signal that was broadcast.

Example (from schema)

{
  "signalKey": "string",
  "tenantId": "string"
}

application/vnd.camunda.api.keys.number+json

Schema

Schema

tenantId string

The tenant ID of the signal that was broadcast.

signalKey int64

The unique ID of the signal that was broadcast.

Example (from schema)

{
  "signalKey": 0,
  "tenantId": "string"
}

application/vnd.camunda.api.keys.string+json

Schema

Schema

tenantId string

The tenant ID of the signal that was broadcast.

signalKey string

The unique ID of the signal that was broadcast.

Example (from schema)

{
  "signalKey": "string",
  "tenantId": "string"
}

400

The provided data is not valid.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

The signal is not found.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...