Skip to main content

setAutomationPayload

A Workflow Engine function that sets the automation solution, instance and Workflow Payload rule set to use for automation requests. Checks the Workflow Payload name against your automation integration for a matching job template name. If found, uses the rule set to generate the request payload. Otherwise, uses the default Workflow Payload rules.

This function currently supports the eyeShare and ignio integrations and directly relates to configurations from these integrations.

setAutomationPayload typically precedes a sendToAutomation action in your workflow, which uses the payload this function generates.

This function is available as a feature of the Add-ons v1.3 download and later.

This function is only available for automation alert and automation Situation workflows.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function setAutomationPayload takes the following arguments:

Name

Required

Type

Description

automationSolution

Yes

String

Name of the automation solution. For example, "Ignio".

automationInstance

Yes

String

Name of the integration instance. For example, "Ignio1".

payloadName

Yes

String

Name of the payload. Must match the Workflow Payload Name in your integration.

Example

The following example demonstrates typical use of Workflow Engine function setAutomationPayload. It assumes you have set up the following:

  • An eyeShare integration with the name "eyeShare1".

  • Within your eyeShare integration, a Workflow Payload instance where you have entered the Workflow Payload Name as "Default".

Set the following:

  • automationSolution: eyeShare

  • automationInstance: eyeShare1

  • payloadName: Default

  • Forwarding Behavior: Stop this workflow. This prevents further processing if the function fails to locate your configuration and returns false.

The UI translates your settings to the following JSON:

{"automationSolution":"eyeShare","automationInstance":"eyeShare1","payloadName":"Default"}
In this section: