HTTP Request

Make an HTTP request to any REST API endpoint

Use it in a workflow

Add a step and choose the HTTP/REST API connector.
Pick the HTTP Request action (under http).
Fill in the fields below, then reference the result from later steps as {{httpRequest.response.data}}.

Fields

urlstring (uri)required

The complete URL to send the request to

methodstringrequired

The HTTP method to use for the request

One ofGETPOSTPUTPATCHDELETEDefault "GET"

timeoutnumber

Maximum time to wait for a response, in milliseconds (default: 30000 — 30 seconds).

Default 30000

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers will override incoming headers.

Default false

headerskeyvalue

HTTP headers to include in the request

queryParamskeyvalue

URL query parameters to append to the request

bodystring

The request body content (for POST, PUT, PATCH requests)

Examples

GET Request

Simple GET request to fetch data

json

{
  "url": "https://jsonplaceholder.typicode.com/users",
  "method": "GET",
  "headers": [
    {
      "key": "Accept",
      "value": "application/json"
    }
  ]
}

POST Request with JSON

POST request with JSON body

json

{
  "url": "https://jsonplaceholder.typicode.com/posts",
  "method": "POST",
  "headers": [
    {
      "key": "Content-Type",
      "value": "application/json"
    },
    {
      "key": "Accept",
      "value": "application/json"
    }
  ],
  "body": "{\"title\": \"My Post\", \"body\": \"Post content\", \"userId\": 1}"
}

GET with Query Parameters

GET request with query parameters

json

{
  "url": "https://api.example.com/search",
  "method": "GET",
  "queryParams": [
    {
      "key": "q",
      "value": "search term"
    },
    {
      "key": "limit",
      "value": "10"
    }
  ]
}

Need more? See the HTTP/REST API guide for connection setup and behaviour shared by every action.

Was this page helpful?