Web Request

Sends an HTTP request to an external URL and returns the response status, headers, and body.

Purpose

Use the Web Request task to integrate a workflow with any external API or web service. It supports all common HTTP methods, configurable authentication, custom headers, and a request body, making it suitable for fetching data from REST APIs, posting records to third-party systems, triggering webhooks, or calling internal services. The full response — including status code and parsed body — is available to downstream tasks.

Inputs

Field	Type	Required	Description
Method	Dropdown	Yes	The HTTP method to use: GET, POST, PUT, PATCH, or DELETE.
Request URL	Text	Yes	The full URL of the endpoint to call.
Authentication Type	Dropdown	Yes	The authentication scheme to apply: None, Basic, Bearer Token, or API Key.
Username	Text	No	Username for Basic authentication. Visible when Authentication Type is Basic.
Password	Text	No	Password for Basic authentication. Visible when Authentication Type is Basic.
Bearer Token	Text	No	Token value for Bearer authentication. Visible when Authentication Type is Bearer Token.
API Key Header Name	Text	No	The header name to send the API key in (e.g. X-API-KEY). Visible when Authentication Type is API Key.
API Key Value	Text	No	The API key value. Visible when Authentication Type is API Key.
Headers (JSON)	Multi-line Text	No	Additional request headers as a JSON object. Authentication headers are added automatically and do not need to be repeated here.
Request Body	Multi-line Text	No	The payload to send with POST, PUT, or PATCH requests.
Timeout (ms)	Text	No	Maximum time in milliseconds to wait for a response. Defaults to 30000.
Allow Redirects	Dropdown	No	Whether to follow HTTP redirect responses automatically. Defaults to true.
Throw on HTTP Error	Dropdown	No	Whether to fail the task when the server returns a 4xx or 5xx status code. Defaults to false.

Visibility Rules

Username and Password are visible when Authentication Type is Basic. Bearer Token is visible when Authentication Type is Bearer Token. API Key Header Name and API Key Value are visible when Authentication Type is API Key.

Outputs

Name	Description
StatusCode	The HTTP status code returned by the server (e.g. 200, 404).
Headers	A dictionary of response headers returned by the server.
Body	The response body, parsed as an object where possible.
IsSuccess	Boolean indicating whether the response indicates success (2xx status).
ErrorMessage	Any error message associated with the response. Empty on success.

Examples

GET – Retrieve data from a public API

Field	Value
Method	GET
Request URL	https://api.spacexdata.com/v5/launches/latest
Authentication Type	None
Headers (JSON)	{"Accept": "application/json"}

POST – Create a resource with Bearer authentication

Field	Value
Method	POST
Request URL	https://api.example.com/users
Authentication Type	Bearer Token
Bearer Token	Auth.Token
Headers (JSON)	{"Content-Type": "application/json"}
Request Body	{"name": "Alice", "role": "admin"}

PATCH – Partially update a resource with an API key

Field	Value
Method	PATCH
Request URL	https://api.example.com/users/101
Authentication Type	API Key
API Key Header Name	x-api-key
API Key Value	123456abcdef
Request Body	{"role": "editor"}