Signals any executions that are listening for a specific signal.
A specific execution ID can be specified and updated process variables can also be included.
Parameters
| Name | Type | Description |
|---|---|---|
| executionId | String | If set, only signal the specified execution. Note that executions are not the same as instances, see the final section of the Messages and Signals knowledge base article for an example |
| fileReferences | Object | Map of field names to file reference objects. The supplied files will be referenced by the workflow and remain available until it completes. For an example see the startProcess function |
| proxyUserId | String | Can be used instead of |
| replaceExistingFiles | boolean | True by default. If this property is true, files named in the "fileReferences" parameter replace any existing files provided under that name which will no longer be referenced by the workflow. Otherwise the new file and and any previous files referenced under that name will be kept |
| signalName | String | The name of the signal event |
| userId | String | This value will be logged in the |
| variables | Object | An optional map of variables to add to the execution |
| signalName and either userId or proxyUserId are required, other parameters are optional | ||
Last modified on January 23, 2024
Share this page
