Question

15.12.1. Signal event received

POST runtime/signals

Notifies the engine that a signal event has been received, not explicitly related to a specific execution.

Body JSON:

{
  "signalName": "My Signal",
  "tenantId" : "execute",
  "async": true,
  "variables": [
    {"name": "testVar", "value": "This is a string"}

  ]
}

Table 224. Signal event received - JSON Body parameters

Parameter	Description	Required
signalName	Name of the signal	Yes
tenantId	ID of the tenant that the signal event should be processed in	No
async	If true, handling of the signal will happen asynchronously. Return code will be 202 - Accepted to indicate the request is accepted but not yet executed. If false, handling the signal will be done immediately and result (200 - OK) will only return after this completed successfully. Defaults to false if omitted.	No
variables	Array of variables (in the general variables format) to use as payload to pass along with the signal. Cannot be used in case async is set to true, this will result in an error.	No

Success response body:

Table 225. Signal event received - Response codes

Response code	Description
200	Indicated signal has been processed and no errors occurred.
202	Indicated signal processing is queued as a job, ready to be executed.
400	Signal not processed. The signal name is missing or variables are used together with async, which is not allowed. Response body contains additional information about the error.