Skip to main content

Response

The Response Activity is primarily used with HTTP Triggers to execute workflows in a synchronous manner — where the workflow returns actual execution results instead of just an execution_id acknowledgment.

This activity is typically placed at the end of the workflow and is responsible for sending the final output back to the client or caller.

Overview​

The Response node allows you to configure how your workflow responds after execution. You can:

  • Choose a Response Code (e.g., 200, 201, 202, 204, 301, 400, 500, 502, etc.).
  • Select a Response Type (e.g., JSON, Text, XML, JavaScript, TSV, CSV, Binary, or ProtoBuf).
  • Define the Response Body, which can include static content or references to results from previous workflow activities.
  • Specify custom Response Headers to include metadata or control information.

Fields​

1. Response Code​

  • Required: Yes
  • Description: Select the appropriate HTTP status code to return. Common examples include:
    • 200 – Success
    • 201 – Resource created
    • 400 – Bad request
    • 500 – Internal server error

2. Response Type​

  • Required: Yes
  • Description: Select the format of the response data. Supported types include:
    • JSON
    • Text
    • XML
    • JavaScript
    • TSV / CSV
    • Binary
    • ProtoBuf

3. Response Body​

  • Required: Yes
  • Description: Define the actual content of the response. You can reference results or data from previous workflow activities using placeholders like {{API_1.result}} or {{Function_1.result.output}}.

4. Response Headers​

  • Required: No
  • Description: Add custom headers to the response for controlling caching, content type, authentication, etc.

Example:

{
  "Content-Type": "application/json",
  "Cache-Control": "no-cache"
}

Example Use Cases​

  • Return API responses directly from your workflow using an HTTP Trigger.
  • Send processed or transformed data back to the client in JSON or XML format.
  • Return detailed error responses when validation or external API calls fail.
  • Provide dynamic HTTP responses including data from multiple workflow steps.

Notes​

  • The Response Activity should always be placed at the end of the workflow.
  • Workflows without a Response node return only an execution_id as acknowledgment.
  • The Response Body can include dynamic data and variables from previous activities.
  • Ensure that the selected Response Type matches the data structure in your response body.