Skip to content

HTTP Client

The HTTP Client worker performs HTTP requests to an external API and returns the response to the workflow.


Parameters

Request

Field Description
Method HTTP method for the request. Accepts Fixed Select. Options: GET, POST, PUT, PATCH, DELETE. Default is GET
URL Target URL for the request. Accepts Template Text or Upstream Data
Query Parameters Key-value pairs appended to the URL as query string parameters. Multiple parameters can be added
Headers Key-value pairs sent as HTTP headers. Multiple headers can be added

Authentication

Field Description
Authentication Type Authentication scheme to use. Accepts Fixed Select. Default is No Authentication

Security

Field Description
Verify SSL Whether to verify the server's SSL certificate. Accepts Boolean. Default is Yes
Certificate Client certificate file for mutual TLS. Accepts Fixed File. Default is No certificate

Advanced

Field Description
Expected Binary Response Whether the response body is binary data. Accepts Boolean. Default is No
Redirect Handling Whether to automatically follow HTTP redirects. Accepts Boolean. Default is Yes
Timeout Request timeout in seconds. Accepts Fixed Number. Default is 60
Retry Count Number of times to retry on failure. Accepts Fixed Number. Default is 1
Pagination Mode Strategy for paginated responses. Accepts Fixed Select. Default is No pagination
Pagination Parameter Name Query parameter name used for pagination. Accepts Template Text or Upstream Data
Static IP Address Read-only. Displays the static IP address of the machine making the request, for use in API allowlists


Result

Once the worker finishes successfully, it returns the HTTP response data to the workflow.

  • Response (object)
  • Status Code (integer)
  • Body (object or string)
  • Headers (object)