HTTP Request Node - Call External REST APIs in ConvyAI Agentic Flow
Overview
The HTTP Request node makes a synchronous REST call to an external endpoint from within an Agentic Flow. The designer configures the URL, HTTP method, headers, and request body; the response status code and body are available as node output for downstream nodes.
Positioning
The HTTP Request node has one input and one output. It can be placed anywhere in the flow after a trigger node.
Configuration
Endpoint
| Field | Description |
|---|---|
| URL | The target endpoint. Supports flow variable references using the standard syntax ($('node').field, $context.x, $input). |
| Method | HTTP method: GET, POST, PUT, PATCH, or DELETE. HEAD and OPTIONS are not supported. |
The node supports REST endpoints only. SOAP calls are not supported in this version.
Body
For requests that include a body, select one of the following encoding modes:
| Mode | Description |
|---|---|
query-string | Parameters appended to the URL as query string. |
json | Parameters serialized as a JSON object in the request body. |
form-data | Parameters sent as multipart/form-data. |
x-www-form-urlencoded | Parameters URL-encoded in the request body. |
In each mode, the interface shows key-value controls for entering the parameters to send. All fields support flow variable references using the standard syntax.
Sending binary files or base64-encoded payloads is not supported in this version.
Headers
Add any number of custom HTTP headers as key-value pairs. Use this section to set authentication headers (Bearer token, API key, Basic auth) alongside any other headers required by the target API. There are no dedicated authentication sections - all headers are managed manually.
Timeout and error behavior
| Field | Description |
|---|---|
| Timeout | Maximum wait time for the request, in seconds. |
| Fail on error | Controls behavior when a timeout, network error, or 5xx response occurs. |
When Fail on error is enabled, the node transitions to a failed state and halts flow execution on any timeout, network error, or 5xx response.
When Fail on error is disabled, the flow continues regardless of the outcome. Downstream nodes can inspect the statusCode and error output fields to handle the result conditionally.
4xx responses are treated as valid protocol responses and do not trigger the error behavior or retry logic.
Retry
| Field | Description |
|---|---|
| Max retries | Maximum number of retry attempts on network errors or timeouts. Accepted values: 0–10. |
| Retry interval | Wait time between retry attempts, in seconds. Accepted values: 1–30. |
Retry applies only to network errors and timeouts. 4xx and 5xx responses are not retried.
Output
The node output is accessible from downstream nodes using the standard syntax ($('httpRequest').response, etc.).
| Field | Type | Description |
|---|---|---|
response | any | The response body returned by the endpoint. |
statusCode | number | The HTTP status code of the response. |
error | object | Present only on error. Contains type and message fields describing the failure. |