Send a Signal - Send a Signal - This operation sends a BPMN signal. Use it to notify signal-catching process elements and optionally pass variables with the signal. - Content Innovation Cloud - Hyland Automate Modeler - Current/Hyland-Automate-Modeler/wye0050968550730 - Current - Current

Hyland Automate Modeler

Platform
Content Innovation Cloud
Product
Hyland Automate Modeler
Release
Current
License
ft:lastPublication
2026-11-16T23:02:28.533499
ft:locale
en-US

This operation sends a BPMN signal. Use it to notify signal-catching process elements and optionally pass variables with the signal.

The base request is:

sendSignal()

The following example sends a signal with a single variable:

new RuntimeProcessInstanceService().sendSignal({
    name: 'approvalReceived',
    variables: {
        approved: true
    }
});

You can use the optional SignalPayload when a script needs to send a BPMN signal. Signals are broadcast by name and can include variables for signal-catching process elements.

The following example sends a signal with multiple variables:

const signalPayload = {
    name: 'approvalReceived',
    variables: {
        approved: true,
        reviewer: variables.reviewer
    }
};

new RuntimeProcessInstanceService().sendSignal(signalPayload);

When a process instance contains a signal-catching event that matches the signal name, the runtime delivers the signal and makes the supplied variables available to the receiving process elements.