Skip to main content

http_request

HTTP Request​

Type: http_request • Category: flow

Description​

Perform HTTP call

Parameters​

NameTypeDescriptionRequiredDefault
urlstringno
methodstringno"GET"
bodyobjectno

Help​

Overview​

The HTTP Call Worker executes a single HTTP request based on the parameters supplied to it. It supports any standard HTTP method, allows an optional request body, and returns the raw response from the target endpoint. This worker is useful for integrating external APIs, triggering webhooks, or performing simple data retrieval tasks within a workflow.

Inputs​

  • url (string, required) – The absolute URL of the endpoint to contact. Must include the protocol (http:// or https://).
  • method (string, optional, default = "GET") – The HTTP verb to use for the request. Accepted values include GET, POST, PUT, PATCH, DELETE, HEAD, and OPTIONS. If omitted, the worker defaults to a GET request.
  • body (object, optional) – A JSON‑serializable object that will be sent as the request payload. The body is only included when the chosen method permits a payload (e.g., POST, PUT, PATCH). For GET or HEAD requests the field is ignored.

Minimal Example Usage​

Below is a minimal set of parameters that triggers a GET request to retrieve a public JSON placeholder resource:

  • url: https://jsonplaceholder.typicode.com/posts/1
  • method: (omitted – defaults to GET)
  • body: (omitted – not needed for a GET request)

If you need to send data, for example a POST request that creates a new resource, the parameters would look like this:

  • url: https://jsonplaceholder.typicode.com/posts
  • method: POST
  • body: { "title": "Foo", "body": "Bar", "userId": 1 }

These parameter objects can be supplied directly to the worker in the workflow definition or via a runtime API call, depending on the surrounding orchestration platform.