Add To Response (Fixed)

Overview

Add To Response (Fixed) adds key-value pairs to the flow response. The value is evaluated when the stage runs and is then stored as a fixed value in the response. Any later changes to the original variable are not reflected in that response field.

Use this stage to return status information, metadata, calculated results, or a snapshot of a variable at a specific point in the flow.

* This example demonstrates how Add To Response (Fixed) captures the value of a variable when the stage executes. Although counter changes later in the flow, the response keeps the original captured value (count = 0).

Note: The variable names, values, criteria, and configuration used in this example are for demonstration purposes only.

Configuration

Required Fields

Value Types

Exit Points

How It Works

When the stage executes, it:

1. Processes each configured key-value pair and reads the Name and Value fields.
2. Resolves the value by using the entered text, variable reference, number, or formula.
3. Stores the resolved result as a fixed value in the response.
4. Continues through the Pass exit to the next connected stage.

Key behavior: The stage stores a snapshot of the value at the moment it runs. If the source variable changes later in the flow, the response field created by this stage keeps the earlier value.

Common Use Cases

1. Add Status and Metadata

Add standard information that should be included in the final response.

Configuration:

• status → success
• timestamp → {{@timestamp}}
• version → 1.0
• userId → {{userId}}

Example response:

{  "status": "success",  "timestamp": 1704067200000,  "version": "1.0",  "userId": "user_123" }

2. Add Calculated Values

Evaluate formulas and include their results in the response.

Configuration:

• totalAmount → {{amount}}
• taxAmount → =({{amount}}*0.1)
• netAmount → =({{amount}}*0.9)
• processed → true

Example response:

{  "totalAmount": 100,  "taxAmount": 10,  "netAmount": 90,  "processed": true }

3. Build a Response Across Multiple Stages

Use more than one Add To Response stage to add fields at different points in the flow.

Stage 1:

• result → success
• processedAt → {{timestamp}}

Stage 2:

• itemCount → {{count}}
• averagePrice → =({{total}}/{{count}})

Result: The final response contains the fields added by both stages.

4. Add Branch-Specific Response Fields

Use Route Flow first, then configure a different Add To Response stage on each branch.

Pass branch:

• status → completed
• duration → {{elapsed}}
• success → true

Fail branch:

• status → failed
• error → {{errorMessage}}

Key Behaviors

Best Practices

• ✓ Use clear and consistent response key names.
• ✓ Use plain text for Name fields and variable references only in Value fields.
• ✓ Place the stage after the values it depends on have been created or calculated.
• ✓ Use formulas when the response needs a calculated value.
• ✓ Use unique key names unless you intentionally want to replace an existing response value.
• ✓ Use Add To Response (Dynamic) when the response must reflect later changes to a variable.
• ✓ Test the final response to confirm the expected values and data types.

Common Mistakes

Troubleshooting

Do's and Don'ts

Do:

• ✓ Use this stage to capture a value at a specific point in the flow.
• ✓ Enter response keys as plain text.
• ✓ Use variable references such as {{userId}} in the Value field.
• ✓ Use formulas such as =({{total}}*0.1) for calculated results.
• ✓ Confirm that required variables exist before the stage executes.

Don't:

• ✗ Do not use variable brackets in the Name field.
• ✗ Do not forget the = prefix for formulas.
• ✗ Do not expect a fixed response value to change after the stage has executed.
• ✗ Do not reuse a response key unless replacing its previous value is intentional.
• ✗ Do not place the stage before the variables or calculations it requires.

Edge Cases

• Variable changes later: The response keeps the value captured when the stage executed.
• Duplicate response keys: A later value using the same key may replace the earlier value.
• Missing variable: The response may contain an empty or null value, depending on the available data.
• Empty static value: An empty value may still be included in the response.
• Formula error: Review the formula syntax and confirm that every referenced variable exists.

Related Stages

• Add To Response (Dynimic): Capture response values when the stage runs.
• Return True: Return a successful completion result.
• Return False: Return a false completion result.
• Change Data: Update variables before the response is generated.
• Set Default Value: Initialize optional variables before using them.