Skip to main content
POST
/
signal
Event
curl --request POST \
  --url http://{host}:{port}/{contextPath}/signal \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "policy_conditions_changed",
  "variables": {
    "newTimePeriodInMonth": {
      "value": 24
    }
  }
}
'
{
  "type": "<string>",
  "message": "<string>",
  "code": 123
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
name
string

The name of the signal to deliver.

Note: This property is mandatory.

​
executionId
string | null

Optionally specifies a single execution which is notified by the signal.

Note: If no execution id is defined the signal is broadcasted to all subscribed handlers.

​
variables
object

A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object.

​
tenantId
string | null

Specifies a tenant to deliver the signal. The signal can only be received on executions or process definitions which belongs to the given tenant.

Note: Cannot be used in combination with executionId.

​
withoutTenantId
boolean | null

If true the signal can only be received on executions or process definitions which belongs to no tenant. Value may not be false as this is the default behavior.

Note: Cannot be used in combination with executionId.

Response

Request successful.