Skip to main content

Using Utility Variables

Access metadata about your Workflow execution for logging, notifications, and personalization

Jake Rosenthal avatar
Written by Jake Rosenthal
Updated over a week ago

Utility Variables provide access to metadata about your current Workflow execution, allowing you to reference information about the run, the user who triggered it, and the Workflow itself.

These variables are particularly useful for personalizing outputs, creating audit trails, sending notifications, and implementing conditional logic within your automations.

How to access Utility Variables

  1. Reference variables in actions and prompts: When configuring an action or prompt in your Workflow, you can reference variables by typing "#" or clicking "Insert Variable".

    For more information on referencing variables in general, see the Referencing variables article.

  2. Navigate to Utilities: In the variable selector dropdown, you'll see a "Utilities" option alongside your trigger inputs and action outputs. Hover over "Utilities" to expand the available utility variables.

  3. Select your desired variable: Choose from the available Utility Variables to insert into your action or prompt. The variable will be automatically formatted with the proper syntax.

Available Utility Variables

Utility Variables are organized into three main categories:

Workflow Run

  • ID: The unique identifier for the current Workflow execution

  • Link: A direct URL link to view the current Workflow run in Cassidy

  • Started At Date (UTC): The date when the Workflow run began, formatted in UTC

  • Started At Date & Time (UTC): The complete timestamp (date and time) when the Workflow run started, in UTC format

  • Is Test Run: A boolean value indicating whether this is a test execution or a live run

Run by User

  • Name: The full name of the user who initiated the Workflow

  • Email: The email address of the user who triggered the Workflow

  • Role: The organizational role (Member/Admin) of the user who started the run

Workflow

  • Name: The display name of the current Workflow

  • Link: A direct URL link to the Workflow configuration page in Cassidy

  • ID: The unique identifier for the Workflow itself (not the specific run)

Example usage

Utility Variables are commonly used for:

  • Personalization: Include the user's name in email outputs or customize content based on their role

  • Logging and audit trails: Include run IDs and user information in output files for tracking and compliance

  • Notifications: Send alerts that include details about who ran the Workflow and when

  • Conditional logic: Use "Is Test Run" to behave differently during testing versus live execution

  • Workflow management: Include Workflow names and links in reports or communications for easy reference

By leveraging Utility Variables, you can create more robust and informative Workflows that provide better tracking, personalization, and context awareness throughout your automation processes.

Did this answer your question?