Variables and helper functions

Variables allow you to access data contained in Forms and Flows to create custom business logic and automations.

Some basic considerations to using variables are:

• Variables are surrounded by curly brackets {{ variable }}.

• If a variable doesn't exist or can't be resolved, it has the same effect as an undefined variable.

• You can use nullish operators to handle null or undefined variables, for example:{{fields.foo ?? fields.bar}}.

You can use different types of variables to reference and transform data you gather from customers with Forms and Flows.

Forms and flows automatically inherit context variables from the current transaction. You can access the following context variables:

• The user object, with access to the following properties:

  • user.user_id

  • user.username

  • user.name

  • user.given_name

  • user.family_name

  • user.nickname

  • user.email

  • user.email_verified

  • user.phone_number

  • user.phone_verified

  • user.picture

  • user.user_metadata

  • user.app_metadata

  • user.created_at

  • user.updated_at

  • user.last_password_reset

  • user.identities

• The organization object, with access to the following properties:

  • organization.id

  • organization.name

  • organization.display_name

  • organization.metadata

• The client object, with access to the following properties:

  • client.client_id

  • client.name

• The tenant object, with access to the following property:

  • tenant.name

• The transaction object, with access to the following property:

  • transaction.state

{
  "user": {
    "user_id": "auth0|658409...",
    "name": "ana@travel0.com",
    "nickname": "ana",
    "email": "ana@travel0.com",
    "email_verified": true,
    "picture": "https://s.gravatar.com/avatar/8eb1b522f6...",
    "user_metadata": {},
    "app_metadata": {},
    "created_at": "2023-12-21T09:46:40.487Z",
    "updated_at": "2024-05-07T10:44:26.271Z",
    "last_password_reset": "2023-12-21T09:49:08.932Z",
    "identities": [
      {
        "user_id": "6584...",
        "isSocial": false,
        "provider": "auth0",
        "connection": "Username-Password-Authentication"
      }
    ]
  },
  "client": {
    "client_id": "xpeg5...",
    "name": "My App"
  },
  "tenant": {
    "name": "tenant-testing"
  },
  "transaction": {
    "state": "hKFo2SBId2M0..."
  }
}

For example:  {{context.user.user_id}} references the user_id of the user object.

Field variables contain data collected from the user from input fields in the form and data from hidden fields. The data of each field varies depending on the field type. For example: {{fields.first_name}} references the input value of a field with the ID first_name.

When a flow action is executed, it generates an output object response that can be referenced in subsequent actions. For example: {{actions.generate_otp.code}} references the output code of the action with ID generate_otp.

You can store variables to be shared with subsequent flows or even with form components in the same transaction. Shared variables are ephemeral and are associated with a specific form journey. Their values cannot be accessed outside of that journey. For example: {{vars.external_id}} references the value of a shared variable with ID external_id.

Helper functions let you transform data and perform simple operations. For example: {{functions.toString(fields.privacy_policies)}} transform the value of the field with ID privacy_policies using the toString() function.

The available helper functions are:

When you add a Form field or a Flow action, the ID is automatically generated. 

Update the ID to a more descriptive value so you can identify the information it contains. For example, if you create a Form field that stores the user’s first name, update the ID to first_name.

If a variable is already in use and you need to modify the ID, identify where you have referenced it and update the ID accordingly to avoid undefined or empty values.

If you see an unexpected variable value, use the Executions view to troubleshoot the variable.

The autocomplete menu helps you locate and properly reference existing variables.