HTTP Request Node
The HTTP Request Node lets you make HTTP calls to any URL, interact with APIs, and connect to external systems.
Supports all major HTTP methods and flexible configuration for headers, authentication, and body data.
Purpose
- Fetch data from third-party APIs (weather, stocks, user data, etc).
- Send data to external systems (create records, post messages, etc).
- Integrate microservices or backend services in your architecture.
- Automate tasks that require web/API interactions.
Configuration
Configurable properties:
Property | Type | Description | Default |
---|---|---|---|
label | string | Descriptive name for the node instance. | 'HTTP Request' |
method | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | HTTP method used for the request. | 'GET' |
url | string | Target URL for the HTTP request. | '' |
queryParams | Array<KeyValueEntry> | Key-value pairs for query params (e.g., ?key1=value1 ). | [] |
headers | Array<KeyValueEntry> | Key-value pairs for HTTP headers. | [] |
bodyType | 'none' | 'json' | 'text' | Type of request body, used for POST , PUT , PATCH . | 'none' |
body | string | Request body content, matching bodyType . | '' |
auth | AuthConfig | Authentication config (None, Basic Auth, Bearer Token, etc). | { type: 'none' } |
KeyValueEntry Structure
Both queryParams
and headers
are arrays of objects:
id
: string (unique identifier)key
: string (parameter/header name)value
: string (parameter/header value)enabled
: boolean (toggle without deleting)
Body Configuration
- none: No body (for
GET
,DELETE
, etc). - json: Body is a valid JSON string.
Content-Type
isapplication/json
.
{
"name": "Example",
"value": 123
}
- text: Body sent as plain text.
Content-Type
may betext/plain
.
The AuthConfig
property supports several authentication schemes. See the "Authentication" documentation section for more info.
Inputs and Outputs
Input (Left Handle):
- Receives a trigger signal to execute the node.
- Optionally receives data from upstream nodes (can be used for templating).
Output (Right Handle):
- Emits an object with the HTTP request result:
- statusCode: HTTP status code (e.g., 200, 404)
- headers: Response headers object
- body: Response body (string, JSON, etc)
- error: Error info if the request failed
Example: Fetching User Data
Fetch user data from JSONPlaceholder API:
- label: Fetch User by ID
- method: GET
- url: https://jsonplaceholder.typicode.com/users/1
- queryParams: none
- headers: none
- bodyType: none
- auth: none
Expected Output:
{
"statusCode": 200,
"headers": {
"content-type": "application/json; charset=utf-8"
// ... other headers
},
"body": {
"id": 1,
"name": "Leanne Graham",
"username": "Bret",
"email": "Sincere@april.biz"
// ... other fields
}
}
Error Handling
Always check the statusCode
and error
fields in the output for handling errors, invalid URLs, or API-specific failures.
Advanced
- Templating: (If available, explain referencing input or global variables in URL, headers, body).
- Retries & Timeouts: (If configurable, describe how to set these).
The HTTP Request Node connects your workflow with the web, APIs, and the external world.
Loading search features...