Whether an expression is entered manually or chosen using the variable picker,it will be saved in the Workflow YAML using the syntax shown below.

Dynamic Variables follow a structured syntax enclosed within double curly braces {{ }}. The syntax specifies the variable type and its reference path within the workflow. Understanding this format allows you to insert variables manually when necessary or desired.

Tip

When working with dynamic variables, sometimes the value can be null, which can cause issues when displaying values in the variable picker or workflow inputs.

Here is a useful tip to replace null with a default value:

  1. If a variable might be null, you can use a ternary-style expression to replace it with a fallback value:
    • {{event.payload.case.vendors != null ? event.payload.case.vendors : "N/a"}}
  2. Another approach is to force the variable into a string format, which can ensure it does not remain null:
    • str({{steps.s2.output}})

​
General Syntax Structure

{{ category.identifier }}

  • category defines the dynamic variables type (e.g., inputs, steps, event, metadata).

  • identifier specifies the exact reference within the category.

  • For example, referencing an input parameter named ‘slack_channel’:

{{ inputs.slack_channel }}

​
Adding Dynamic Variables Manually in a Workflow

​
Workflow Input Parameters

To reference data entered in workflow inputs, use the following syntax:

{{ inputs.param_name }}

param_name represents the name you assigned to the input parameter.

​
Event payload

To reference data returned from an event payload that triggered an Event-Based Workflow, use the following syntax:

{{ event.payload }}             # full event payload
{{ event.payload.issue.user }}  # fetch the value of user attribute in event payload that can look like this: { "issue": {"user": "me" }}

​
Step Output Variables

To reference data returned from a step’s output, use the following syntax:

{{ steps.S1.output }} #  S1 refers to the step’s ID

The S in steps.S1.output represents a step in the workflow, and the number following it (1 in this case) indicates the specific step being referenced. Each step in a workflow is assigned a unique identifier (S1, S2, etc.), allowing you to retrieve outputs from a particular step.

💡 You can also use last instead of a step ID to reference the most recent step output:

{{ steps.last.output }}

​
Step Status

To check the execution status of a previous step, use the following syntax:

{{ steps.S1.status }}

​
Workflow Variables

To use Workflow’s variables created by the Set Variable Action, use the following syntax:

{{ variables.variable_name }}

​
Metadata Variables

To access metadata (workflow-related information), use the following syntax

{{ metadata.automation_name }}  # Workflow name
{{ metadata.automation_url }}   # Workflow link
{{ metadata.automation_id }}    # Workflow ID
{{ metadata.workspace_id }}      # Workspace ID
{{ metadata.pack_id }}          # Pack ID
{{ metadata.execution_id }}     # Execution ID
{{ metadata.execution_url }}    # Execution link
{{ metadata.start_time }}       # Execution start time
{{ metadata.user_email }}       # User who started execution
{{ metadata.user_groups }}      # User's assigned groups

​
Python Actions

The syntax for referencing data returned from Python actions is different. In steps that include Python actions, you need to use the context variable to access dynamic variables. This means that all the expressions mentioned above can be accessed in Python using the following syntax:

context.inputs.param_name  # Input parameter
context.steps.S1.output  # Step output
context.steps.S1.output.user.id  # Specific key in step output
context.steps.last.output  # Last executed step output
context.steps.S1.status  # Step status
context.event.payload  # Full event payload
context.event.payload.issue.user  # Specific key in event payload
context.metadata.automation_name  # Metadata variable

In Python actions, variables can be assigned a value, by using the following syntax:

context.variables.variable_name = value # Assign a value to a workflow variable

​
Best Practices

  • Use the Variable Picker to avoid syntax errors.
  • When referencing JSON keys with dots (.), use square bracket notation if needed.
  • Step outputs are only available after execution; ensure dependencies are correctly structured.

Was this page helpful?