External signal external-signal
The External signal activity is a Flow control activity. It allows you to trigger the execution of a workflow from another workflow or from an API call.
Follow these steps to configure the External signal activity and trigger its execution:
-
Add an External signal activity into your workflow.
-
Complete the configuration of your workflow and start its execution. The External Signal activity displays as 鈥淧ending鈥, waiting to be triggered.
-
Retrieve the information below:
-
The workflow鈥檚 internal name, which displays next to its label.
accordion View example 
-
The External signal activity鈥檚 name, which displays in the workflow鈥檚 Execution options.
accordion View example 
-
-
To trigger the workflow, you need to execute the
PostEventJavaScript function. This function allows you to pass variables with the values of your choice and leverage them in the triggered workflow.The
PostEventfunction can be executed either from another workflow, or from an API call.-
To trigger an External signal activity from a workflow, execute the PostEvent function from the Initialization script pane, which is accessible from the activity鈥檚 Execution options. For the JavaScript code activity, execute the function from the activity鈥檚 script.
The syntax is as follows:
code language-none xtk.workflow.PostEvent("<workflow-internal-name>","<signal-activity-name>","",<variables <variable-name>="<value>"/>, false);
accordion View example In this example, we are triggering the 鈥渟ignal1鈥 External signal activity that has been added to the workflow whose internal name is 鈥淲KF12345鈥. We are also passing a variable named 鈥渃ustomID鈥, with the value 鈥123456鈥.
- To trigger an External signal activity from an API call, follow the steps detailed in the Campaign API documentation. Learn how to use the static
PostEventmethod
-