Web Request

The Web Request node sends a request to a specified web API or service and returns the response. It lets workflows interact with external systems by calling endpoints, passing parameters or headers, and using the returned data in later steps.

---

Dependencies

• Requires network access to target API/Service.
• Requires a valid endpoint URL.
• May require authentication to be configured prior to use.

---

Method

Method	Description
Get	Retrieves data from the specified resource.
POST	Creates a new resource with the provided data.
PUT	Replaces an existing resource with the provided data.
PATCH	Updates part of an existing resource.
DELETE	Removes the specified resource.

---

Input Fields

Label	Input Type	Description	Required	Visible When	Default	Example
Method	Picklist	The HTTP method to use for the request (e.g., GET, POST, PUT, PATCH, DELETE).	✅ Yes	Always	Null	GET
Request URL	Text	The target endpoint URL for the HTTP request.	✅ Yes	Always	Null	https://api.spacexdata.com/v5/launches/latest
Authentication Type	Picklist	The authentication method used for the request (e.g., None, Basic, Bearer Token, API Key).	✅ Yes	Always	Null	None
Username	Text	The username used for API authentication.	⚠️ When Visible	When Auth Type is Basic	Null	mv_user
Password	Text	The password used for API authentication.	⚠️ When Visible	When Auth Type is Basic	Null	Password123!
Bearer Token	Text	The bearer token used for API authentication.	⚠️ When Visible	When Auth Type is Bearer Token	Null	Bearer {Token}
API Key Header Name	Text	The header field name used for API authentication.	⚠️ When Visible	When Auth Type is API Key	Null	x-api-key
API Key Value	Text	The API key used for API authentication	⚠️ When Visible	When Auth Type is API Key	Null	123456abcdef
Headers (JSON)	Text	Request headers in JSON format. Allows adding values such as Content-Type or authorization tokens.	❌ No	Always	Null	{"Content-Type": "application/json", "Accept": "application/json"}
Request Body	Text	The request payload, usually required for POST, PUT, or PATCH requests. Should be JSON, XML, or form-encoded data.	❌ No	Always	Null	{"name": "John Doe", "role": "admin"}
Timeout (ms)	Text	Maximum time (in milliseconds) to wait for a response before failing.	❌ No	Always	30000	15000
Allow Redirects	Picklist	Whether the request should automatically follow HTTP redirects (3xx).	❌ No	Always`	false	false
Throw on HTTP Error	Picklist	Whether non-2xx HTTP responses (e.g., 400, 401, 500) should throw an error.	❌ No	Always	Null	false

---

Output

The result of the web request can be referenced downstream using {{WebRequest-#.Result}}.

The output includes the HTTP status, headers, response body, and metadata fields.

Structure:

{
  "StatusCode": 200,
  "Headers": {
    "Content-Type": "application/json",
    "Server": "cloudflare"
  },
  "Body": {
    "name": "Crew-5",
    "success": true
  },
  "IsSuccess": true,
  "ErrorMessage": ""
}

---

Examples

GET – Retrieve data from an API.

Request the latest SpaceX launch data.

Field	Value
Method	GET
Request URL	https://api.spacexdata.com/v5/launches/latest
Authentication Type	None
Headers (JSON)	{"Accept": "application/json"}
Output	JSON containing launch details (name, date, rocket, etc.)

{
  "name": "Crew-5",
  "date_utc": "2022-10-05T16:00:00.000Z",
  "success": true,
  "rocket": "5e9d0d95eda69973a809d1ec"
}

POST – Create a new resource.

Request the latest SpaceX launch data.

Field	Value
Method	POST
Request URL	https://api.example.com/users
Authentication Type	Bearer Token
Bearer Token	eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.DUMMY_SIGNATURE
Headers (JSON)	{"Content-Type": "application/json"}
Authentication Type	{"name": "Alice", "role": "admin"}
Output	JSON confirming the new user was created.

{
  "id": 101,
  "name": "Alice",
  "role": "admin",
  "createdAt": "2025-09-01T10:15:30Z"
}

PUT – Replace an existing resource.

Update a user’s details (full replacement).

Field	Value
Method	PUT
Request URL	https://api.example.com/users/101
Authentication Type	Bearer Token
Bearer Token	eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.DUMMY_SIGNATURE
Headers (JSON)	{"Content-Type": "application/json"}
Authentication Type	{"name": "Alice", "role": "superadmin"}
Output	JSON with the updated record.

{
  "id": 101,
  "name": "Alice",
  "role": "superadmin"
}

PATCH – Partially update an existing resource.

Update a user’s details (full replacement).

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
Headers (JSON)	{"Content-Type": "application/json"}
Request Body	{"role": "editor"}
Output	JSON with the updated field.

{
  "id": 101,
  "name": "Alice",
  "role": "editor"
}

DELETE – Remove a resource.

Update a user’s details (full replacement).

Field	Value
Method	DELETE
Request URL	https://api.example.com/users/101
Authentication Type	Basic
Username	mv_user
Password	Password123!
Headers (JSON)	{"Accept": "application/json"}
Output	Confirmation message or empty response.

{
  "message": "User 101 deleted successfully."
}

---

Potential Errors

Error Condition	Description
WIP	WIP

---

Developer Notes

• WIP

---