Environment variables

There is a list of Tray environment variables (prefixed with $.env) that - at any point in your workflow - can be used to access basic info about the workflow/solution environment. These are:

1
$.env.execution_uuid
2
$.env.execution_start_time
3
$.env.execution_log_url
4
$.env.organization_uuid
5
$.env.project_id
6
$.env.solution_id
7
$.env.solution_instance_id
8
$.env.source_workflow_uuid
9
$.env.workflow_uuid
10
$.env.workflow_title
11
$.env.workspace_id

The execution uuid​

Copy

The $.env.execution_uuid environment variable is potentially of key importance in managing statuses and errors.

It is the id which is generated every time a workflow is run.

It could be linked to an external execution id (which may have been pulled in from a webhook) - both of which could be stored in Data Storage and retrieved later in the workflow or stored at account level and retrieved in any child workflows which are called.

The workflow uuid​

Copy

The $.env.workflow_uuid environment variable is basically the uuid found in your workflow url:

An example of using $.env.workflow_uuid can be found in our documentation on workflow threads

In this case it is used as a suffix for an account-level data storage variable, to identify that the variable is connected to that workflow

Callable workflow trigger variables​

Copy

Callable workflows have the following environment variables available from their trigger output:

1
$.steps.trigger.#calling_workflow
2
$.steps.trigger.#calling_execution
3
$.steps.trigger.#calling_execution_log_url

The $.steps.trigger.#calling_workflow environment variable can be used to obtain the uuid of the calling workflow.

Again, this is used in our documentation on workflow threads - to make sure the calling workflow accesses the account-level data storage list that was created by the calling workflow.

Embedded environment variables​

Copy

There is a further list of environment variables that can be used to access basic info about the solution environment in your Embedded integrations.

These are:

1
$.env.execution_uuid
2
$.env.execution_start_time
3
$.env.user_id
4
$.env.external_user_id
5
$.env.execution_log_url
6
$.env.workflow_uuid
7
$.env.workflow_title
8
$.env.solution_id
9
$.env.solution_instance_id
10
$.env.source_workflow_uuid

For example, if you have a step which produces the following error output:

You could use the following:

To format a message which would produce the following:

Environment variables and fallback values

Copy