Response
Send structured API response
Configuration
Response Data Mode
Builder
Choose how to define your response data structure
Response Structure
Response Structure
Define the structure of your response data. Use exact workflow variable tags like <variable.userId> in field names when needed. Shown when dataMode is 'structured'.
Response Data
json
{
"message": "Hello world",
"userId": "<variable.userId>"
}
Data that will be sent as the response body on API calls. Use exact upstream output tags like <agent.content> and exact workflow variable tags like <variable.userId>. Shown when dataMode is 'json'.
Status Code
200
HTTP status code (default: 200)
Response Headers
Response Headers
Additional HTTP headers to include in the response
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
dataMode | string | No | Response data definition mode |
builderData | json | No | Structured response data. Shown when dataMode is 'structured'. |
data | json | No | JSON response body. Shown when dataMode is 'json'. |
status | number | No | HTTP status code |
headers | json | No | Response headers |
Output
| Parameter | Type | Description |
|---|---|---|
response | object | Structured response prepared for the caller. |
response.data | json | Response body. |
response.status | number | HTTP status code, defaulting to 200. |
response.headers | json | HTTP response headers. |
Usage Instructions
Define a structured workflow response using Builder fields or a JSON object in Editor mode. The block returns a response object containing data, status, and headers; downstream tags therefore use response.data beneath this block. API-triggered executions can expose this as their HTTP response. A webhook trigger acknowledges delivery before background execution, so a Response block cannot customize that earlier acknowledgment. Invalid response data is returned as a response with status 500. The block does not stop other connected workflow paths by itself.
Notes
- Category:
blocks - Type:
response