Data input and output: Input and output variables

Input and output in Rewst

To understand this topic, you'll first need to learn the difference between an input and an output.

• An input is information that will be put into Rewst automations. This could be the contents of a form, or information sent via integration, for example.

• An output is the expected result of the automation.

If outputs are the return value of a workflow, inputs are the parameters — they're how you pass data into a workflow from the outside, rather than pulling data out of it.

When you ask the Rewst Agent to build for you, it will handle setting up inputs and outputs for your workflow. The below explanation will help you understand what the Rewst Agent will ask of you to properly build on your behalf.

Workflow input: Input variables

Workflow inputs are commonly known as input variables. An input variable is a named piece of data that you define on a workflow to tell it "expect this value to be passed in when you run." They provide data that can be used by tasks within the workflow, or into a workflow called by another workflow. Input variables seed the workflow's context before any tasks run. Rather than hardcoding values directly into your tasks, you define them as inputs so the workflow can behave dynamically depending on what's passed in. Once defined, the value is available inside the workflow as {{ INPUT.variable_name }} or {{CTX.INPUT.variable_name }} .

Input variables can be broken down into two parts:

1. A key

2. The specific data or values that vary

This is an example of a variable where [first_name] is the key and Ashley is the value:

[first_name] : "Ashley"

Input variables get their values in a Rewst workflow through the workflow's initial trigger event. Any data type that is valid in JSON can be used as an input variable. Set up new input variables in the trigger node, or directly in the configuration menu, as depicted in the next section.

Input variables can only be modified or added on the source workflow, not clones of workflows unpacked from Crates.

Workflow output: Output variables

Similarly, workflow outputs are commonly known as output variables. An output variable is a named mapping you configure in a workflow's settings. It links a name to a variable, essentially indicating "when this workflow finishes, expose this piece of data under this name." This is how a workflow communicates results to whatever called it, whether that's a form or a parent workflow.

Add an input variable

You can add new variables, or modify existing ones, by navigating to your Workflow > Configure > Inputs.

Click Add Input to see a number of new fields.

1. Name: This can be a unique entry relevant to what the aim of the input is going to be. This should not contain spaces.

2. Label: This text field is used to set a friendly name. It's the field name visible at the time of input.

3. Type: Short for data type, this field defines what format the data will be in.

   1. String

   2. Number

   3. Boolean

   4. Object

   5. Array

   6. Datetime

   7. File

   8. URL

   9. Email

   10. Enum

4. Description: Give a description of what the input is used for.

5. Default: You can specify a value that will be used if no other input is specified manually.

6. Optionally, check the boxes if you wish for your input variable to be Required or Secret.

Add an output variable

Add new output variables, or modify existing ones, by navigating to your Workflow > Configure > Outputs.

Click Add Output to see a number of new fields.

1. Name: This can be a unique entry relevant to what the aim of the input is going to be. This should not contain spaces.

2. Label: This text field is used to set a friendly name. It's the field name visible at the time of input.

3. Value binding: Click to expose the dialog, where you can choose from the populated list of outputs from your workflow.

4. Type: Short for data type, this field defines what format the data will be in.

   1. String

   2. Number

   3. Boolean

   4. Object

   5. Array

   6. Datetime

   7. File

   8. URL

   9. Email

   10. Enum

5. Description: Give a description of what the input is used for.

6. Optionally, check the box if you wish for your output variable to be Secret.

Click the Outputs tab of any node to see its output schema, the sample response structure based on the connector definition.