HTTP

Make HTTP requests to URLs such as REST APIs, Webhooks, etc.

Component key: http

Description#

The HTTP component allows you to make GET, POST, PUT, PATCH, and DELETE requests to web endpoints. For all actions, you can specify:

  • A URL to send a request to
  • A response type (like "json")
  • A list of request headers
  • A list of query parameters

In addition, the POST, PUT, and PATCH actions allow you to specify data to send as part of the request. data can be a reference to a binary file, a string literal, or any structured data that is expected in the body of the request.

Authorization Methods#

HTTP can use the following authorization methods, though no authorization method is required:

Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

Basic AuthbasicBasic authorization using a username/password combination

Password |  password

Username |  username

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Authorization URL |  auth_uri

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Access Token URL |  token_uri

OAuth 2.0 - Client Credentialsoauth2_client_credentialsOAuth 2.0 authorization using the client credentials grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Access Token URL |  token_uri

This component can be configured to use optional basic auth or OAuth 2.0 credentials to authenticate the request.

Actions#

DELETE request#

Issue a HTTP DELETE request | key: httpDelete

InputKeyDefaultNotesExample

Header

string
headersA list of headers to send with the request.User-Agent: curl/7.64.1

Query Parameter

string
queryParamsA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

string
responseTypejsonThe type of data you expect in the response. You can request json, text, or binary data.binary

URL

string
/ Required
urlThis is the URL to call.https://api.company.com/endpoint

Output Example Payload#

{
"data": null,
"contentType": "application/json"
}

GET Request#

Issue a HTTP GET request | key: httpGet

InputKeyDefaultNotesExample

Header

string
headersA list of headers to send with the request.User-Agent: curl/7.64.1

Query Parameter

string
queryParamsA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

string
responseTypejsonThe type of data you expect in the response. You can request json, text, or binary data.binary

URL

string
/ Required
urlThis is the URL to call.https://api.company.com/endpoint

Output Example Payload#

{
"data": null,
"contentType": "application/json"
}

PATCH request#

Issue a HTTP PATCH request | key: httpPatch

InputKeyDefaultNotesExample

Data

string
/ Required
dataThe HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.{"exampleKey": "Example Data"}

Header

string
headersA list of headers to send with the request.User-Agent: curl/7.64.1

Query Parameter

string
queryParamsA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

string
responseTypejsonThe type of data you expect in the response. You can request json, text, or binary data.binary

URL

string
/ Required
urlThis is the URL to call.https://api.company.com/endpoint

Output Example Payload#

{
"data": null,
"contentType": "application/json"
}

POST Request#

Issue a HTTP POST request | key: httpPost

InputKeyDefaultNotesExample

Data

string
/ Required
dataThe HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.{"exampleKey": "Example Data"}

Header

string
headersA list of headers to send with the request.User-Agent: curl/7.64.1

Query Parameter

string
queryParamsA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

string
responseTypejsonThe type of data you expect in the response. You can request json, text, or binary data.binary

URL

string
/ Required
urlThis is the URL to call.https://api.company.com/endpoint

Output Example Payload#

{
"data": null,
"contentType": "application/json"
}

PUT request#

Issue a HTTP PUT request | key: httpPut

InputKeyDefaultNotesExample

Data

string
/ Required
dataThe HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.{"exampleKey": "Example Data"}

Header

string
headersA list of headers to send with the request.User-Agent: curl/7.64.1

Query Parameter

string
queryParamsA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

string
responseTypejsonThe type of data you expect in the response. You can request json, text, or binary data.binary

URL

string
/ Required
urlThis is the URL to call.https://api.company.com/endpoint

Output Example Payload#

{
"data": null,
"contentType": "application/json"
}