Trigger Message Event Subscription
Delivers a message to a specific execution by id, to trigger an existing message event subscription. Inject process variables as the message’s payload.
Method
POST /execution/{id}/messageSubscriptions/{messageName}/trigger
Parameters
Path Parameters
Name | Description |
---|---|
id | The id of the execution to submit the message to. |
messageName | The name of the message that the addressed subscription corresponds to. |
Request Body
A JSON object with the following properties:
Name | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
variables | A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object.
|
Result
This method returns no content.
Response Codes
Code | Media type | Description |
---|---|---|
204 | Request successful. | |
400 | application/json | The variable value or type is invalid, for example if the value could not be parsed to an Integer value or the passed variable type is not supported. See the Introduction for the error response format. |
500 | application/json | The addressed execution has no pending message subscriptions for the given message. See the Introduction for the error response format. |
Example
Request
POST /execution/anExecutionId/messageSubscriptions/someMessage/trigger
Request Body:
{"variables" :
{"aVariable" : {"value" : true, "type": "Boolean"},
"anotherVariable" : {"value" : 42, "type": "Integer"}}
}
Response
Status 204. No content.