Set Variable

Reference documentation for using the Set Variable action

Written By Support Channel

Last updated 8 months ago

Overview of the Set Variable action

The Set Variable action allows you to create or update a variable in your workflow and utilise them again later in your logic. Examples of this include transferring data between actions, saving computed results, and collecting user input.

Purpose

Stores data that can be used in the workflow

Parameters

1 or more Variable Names
1 or more Variable Values

Output

Provides access to the value of a variable

Understand the Set Variable action

To successfully use the Set Variable action, a few key settings must be configured. These settings define what the variable is called and the value to be used to initialise your variable.

Variable Name

Enter a name for the variable you want to create or update. This name is how you’ll reference the stored value later in your workflow. For example: userName

Value (Expression)

Enter the value you want to store in the variable. This can be static text, a number, or a dynamic expression pulled from a previous step (like form input, API response, or calculation).

To update a variable’s value, simply use the Set Variable action again with the same name (this is a case sensitive field, for example username will create a new variable but userName will update the original). The new value you enter will overwrite the previous one.

Create and manage User Email actions

Add a User Email action

Add the action

Use the following steps to add the action to a workflow.

Configure the action

Use the following steps to configure the action.

  1. Click Add Variable to add a new variable.

  2. Name the variable and give it a value in the Expression field. This can be a simple value such as a Number or Text string, or it can be the return value of an expression.

  3. Click OK to complete setup of your new variable.

  4. Click back in the main view to hide the slide-over.

Delete a User Email action

Use the following steps to remove the action from your workflow:

Take care when deleting an action to also remove any logic using its outputs: workflow steps may function incorrectly or break if they attempt to evaluate an output of a deleted action.

Any attempt to read a variable that has been removed will return an empty result. In addition, removing a Set Variable action from the workflow will not cause actions or expressions configured to use the variable to update. So take care when you remove a variable to ensure that other actions or expressions are not trying to use it.

Using a Set Variable action

After configuring your Set Variable action, you will be able to call it using the / tag control to utilise your variable under the Variable category.