Response

The Response block is the final step in your workflow that formats and returns data to whoever called your workflow. It's like the "return" statement for your entire workflow—it packages up results and sends them back.

When You Need Response Blocks

API Endpoints: When your workflow is called via API, Response blocks format the return data Webhooks: Return confirmation or data back to the calling system Testing: See formatted results when testing your workflow Data Export: Structure data for external systems or reports

Two Ways to Build Responses

Builder Mode (Recommended)

Visual interface for building response structure:

• Drag and drop fields
• Reference workflow variables easily
• Visual preview of response structure

Editor Mode (Advanced)

Write JSON directly:

• Full control over response format
• Support for complex nested structures
• Use <variable.name> syntax for dynamic values

Configuration Options

Response Data

The response data is the main content that will be sent back to the API caller. This should be formatted as JSON and can include:

• Static values
• Dynamic references to workflow variables using the <variable.name> syntax
• Nested objects and arrays
• Any valid JSON structure

Status Code

Set the HTTP status code for the response. Common status codes include:

Default status code is 200 if not specified.

Response Headers

Configure additional HTTP headers to include in the response.

Headers are configured as key-value pairs:

Inputs and Outputs

Variable References

Use the <variable.name> syntax to dynamically insert workflow variables into your response:

{
  "user": {
    "id": "<variable.userId>",
    "name": "<variable.userName>",
    "email": "<variable.userEmail>"
  },
  "query": "<variable.searchQuery>",
  "results": "<variable.searchResults>",
  "totalFound": "<variable.resultCount>",
  "processingTime": "<variable.executionTime>ms"
}

Example Usage

Here's an example of how a Response block might be configured for a user search API:

data: |
  {
    "success": true,
    "data": {
      "users": "<variable.searchResults>",
      "pagination": {
        "page": "<variable.currentPage>",
        "limit": "<variable.pageSize>",
        "total": "<variable.totalUsers>"
      }
    },
    "query": {
      "searchTerm": "<variable.searchTerm>",
      "filters": "<variable.appliedFilters>"
    },
    "timestamp": "<variable.timestamp>"
  }
status: 200
headers:
  - key: X-Total-Count
    value: <variable.totalUsers>
  - key: Cache-Control
    value: public, max-age=300

Best Practices

• Use meaningful status codes: Choose appropriate HTTP status codes that accurately reflect the outcome of the workflow
• Structure your responses consistently: Maintain a consistent JSON structure across all your API endpoints for better developer experience
• Include relevant metadata: Add timestamps and version information to help with debugging and monitoring
• Handle errors gracefully: Use conditional logic in your workflow to set appropriate error responses with descriptive messages
• Validate variable references: Ensure all referenced variables exist and contain the expected data types before the Response block executes