Web Request
Provides a generic HTTP client for invoking web services that do not require OpenAPI or WSDL metadata. Supports simple REST-style requests for lightweight integrations and utility calls, with support for streaming bodies and optional authentication headers.
Revision History
1.0.0.3 - Initial release.
Connection
The connection holds the base URL, the authentication scheme, and how HTTP failure responses are surfaced. Per-request URLs may be relative (combined with BaseUrl) or absolute (which override BaseUrl).
| Property | Type | Description |
|---|---|---|
BaseUrl |
String | Base URL used as a prefix for relative request URLs. |
Authorization |
AuthorizationType | Authentication type to apply to requests: None, Basic, or Bearer. |
Username |
String | Username used when Authorization is Basic. |
Password |
Masked | Password used when Authorization is Basic. |
Bearer Token |
Masked | Token used when Authorization is Bearer. |
Return Http Failure Responses |
Boolean | When true, HTTP responses with status 400 or higher are returned in the response object. When false, those responses throw an error that you can handle with a Try-Catch Node. |
Setup Notes
- Supply either a
ConnectionwithBaseUrl, aURL, or both. If both are missing, the request fails. - Use a relative
URLwhenBaseUrlis set on the Connection. - Use an absolute
URLwhen you want to overrideBaseUrlfor a single request. - Configure
BasicorBearerauthentication on the Connection instead of sending anAuthorizationheader inHeaders.
Methods
The node exposes one method per supported HTTP verb. Methods that can carry a payload (Post, Put, Patch) accept a streamed RequestBody; Get and Delete do not.
| Parameter | Type | Description |
|---|---|---|
Connection |
Connection | Optional Connection settings, including authentication and base URL. |
URL |
String | Relative or absolute request URL. |
Headers |
Object | Optional request headers as key-value pairs, merged with any headers applied by the Connection. |
RequestBody |
Stream | Optional payload stream forwarded directly as the request body. |
| Return | Type | Description |
|---|---|---|
StatusCode |
Integer | HTTP status code returned by the server. |
ResponseHeaders |
Object | Response headers returned by the server. |
ResponseStream |
Stream | Response body stream. |
Get
Executes an HTTP GET request and returns the response.
Post
Executes an HTTP POST request and returns the response.
Put
Executes an HTTP PUT request and returns the response.
Patch
Executes an HTTP PATCH request and returns the response.
Delete
Executes an HTTP DELETE request and returns the response.
Usage Notes
- Request and response bodies are streamed, so large payloads are not buffered in memory before they are sent or returned.
- Set
Content-TypeinHeaderswhen you send aRequestBody. If you do not set it, the request body defaults toapplication/octet-stream. - If
Return Http Failure Responsesisfalse, HTTP responses with status400or higher throw an error instead of returning a normal response. - If
Return Http Failure Responsesistrue, HTTP responses with status400or higher are returned withStatusCode,ResponseHeaders, andResponseStreamso you can inspect them in the same Workflow path.
Known Issues
- Client TLS certificates are not supported.