Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      


Updated on December 13, 2022

Runs an activity from a script.




Not applicable.


nameSpecifies the name of the activity that the API launches.String
parametersSpecifies the parameters for the activity in an array.JSON object
contextPageSpecifies the name of the context page for the activity. By default, the activity runs in the primary page context.String
eventSpecifies the event that launches the activity.DOM event object
For example:

In the following example...

var options = {
                name: “activityName ",
                parameters: [{name: "param1", value: "Page1.prop1", isProperty: true},  {name: "param2", value: 123, isProperty: false}],
                contextPage: "page1.page2 ",
                event: eventObject


Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us