Skip to main content

Pass Parameters to Workflows

Business

Passing parameters to workflows enables dynamic configuration and execution, allowing for flexible data handling and processing. This page explains how to effectively pass parameters to workflows from Appsmith app or external systems.

From the Appsmith app​

  • All parameters: Read data from different widgets, create a JSON object, set all parameters, and their values as shown below:

    {
      "name": "{{NameInput.text}}",    // reads the value from the "NameInput" widget
      "email": "{{EmailInput.text}}",  // reads the value from the "EmailInput" widget
      "phone": "{{PhoneInput.text}}"   // reads the value from the "PhoneInput" widget
    }

    In your workflow query, reference all parameters using {{this.params}}. This allows you to send all parameters with their dynamic values.

  • Specific parameter: Read data from a specific widget, set it as the parameter value, and pass it to the workflow query using {{this.params.parameter_name}}. For example, if you wish to only pass email as parameter:

    {
      // Only passing the value from the "EmailInput" widget
      "email": "{{EmailInput.text}}"  
    }

    In your workflow query, reference a specific parameter like this:

    {{ this.params.email }}

From external systems​

When connecting to an external system, you pass parameters in the request body.

  • All parameters: Create a JSON object with all required parameters and include it in the request body when executing the workflow.

    {
      "name": "John Doe",
      "email": "john.doe@example.com",
      "phone": "123-456-7890"
    }

  • Specific parameter: Include the specific parameter in JSON format in the request body when executing the workflow.

    {
      "email": "john.doe@example.com"
    }

Accessing parameters in workflows​

Once parameters are passed to a workflow, you can access them within the workflow's logic.

Read parameter values in workflow​

You can access the parameter values using dot notation with the data object. For example:

const userEmail = data.email;  // Accesses the "email" parameter
const userName = data.name;    // Accesses the "name" parameter
const userPhone = data.phone;  // Accesses the "phone" parameter

Pass parameters to internal queries​

Use these parameters to call queries within the workflow and pass the parameters to them.

  • Pass all parameters: Pass all parameters to the underlying queries by spreading data. 
    // Passing all parameters to an underlying query named SaveUserDetails
    SaveUserDetails.run({
    ...data  // Passes all parameters from the workflow to the query
    });
  • Pass specific parameters: Pass a specific parameter by using {"parameter_name": data.parameter_name}. 
    // Example: Passing a specific parameter to an underlying query named "SaveEmail"
    SaveEmail.run({
    "email": data.email  // Passes only the "email" parameter to the query
    });

Read parameters to process queries​

In the underlying queries within the workflow, read the parameters using the {{ this.params.parameter_name }} syntax.

// Example: Reading parameters in a query
const userEmail = {{ this.params.email }};  // Reads the "email" parameter
const userName = {{ this.params.name }};    // Reads the "name" parameter

Important considerations​

  • Ensure that parameter names are consistently referenced in the workflow and in the underlying queries to avoid errors.
  • Handle exceptions and rejections from promises to prevent uncaught errors that disrupt your workflow processing.

See also​