Skip to main content

HTTP Component

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

Component key: http

Description#

The HTTP component allows you to make requests to an HTTP-based API or endpoint.

Common HTTP verbs like GET, POST, PUT, PATCH, and DELETE are supported. For all actions, you can specify:

  • A URL to send a request to
  • A response type (like application/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.

This component can be configured to use optional Basic Auth (username/password), API Key, or OAuth 2.0 Connections to authenticate the request. For other non-standard authentication schemes, you will either need to supply your own Authorization as a header as an input to the HTTP component, or you can create your own custom component to interact with an HTTP-based API.

HTTP Connections#

API Key#

If an API Key Connection is supplied, an Authorization: Basic ${APIKEY} header is used in the HTTP request.

InputNotes
Input
API Key
string
/ Required
Notes
API Key

OAuth 2.0 Authorization Code#

If an OAuth 2.0 Connection are supplied, an Authorization: Bearer ${KEY} header is used in the HTTP request, where KEY is the client key that is fetched from the OAuth provider.

InputNotes
Input
Authorize URL
string
/ Required
Notes
The OAuth 2.0 Authorization URL for the API
Input
Client ID
string
/ Required
Notes
Client Identifier of your app for the API
Input
Client Secret
password
/ Required
Notes
Client Secret of your app for the API
Input
Headers
string
Key Value List
Notes
Additional header to supply to authorization requests
Input
Scopes
string
Notes
Space separated OAuth 2.0 permission scopes for the API
Input
Token URL
string
/ Required
Notes
The OAuth 2.0 Token URL for the API

Basic Username/Password#

If a Basic Auth Connection is supplied, an Authorization: Basic ${base64(USERNAME:PASSWORD)} header is used in the HTTP request.

InputNotes
Input
Password
password
/ Required
Notes
Password
Input
Username
string
/ Required
Notes
Username

OAuth 2.0 Client Credentials#

InputNotes
Input
Client ID
string
/ Required
Notes
Client Identifier of your app for the API
Input
Client Secret
string
/ Required
Notes
Client Secret of your app for the API
Input
Headers
string
Key Value List
Notes
Additional header to supply to token requests
Input
Scopes
string
Notes
Space separated OAuth 2.0 permission scopes for the API
Input
Token URL
string
/ Required
Notes
The OAuth 2.0 Token URL for the API

Actions#

DELETE request#

Issue a HTTP DELETE request | key: httpDelete

InputDefaultNotesExample
Input
Connection
connection
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
 
Notes
Enabling this flag will log out the current request.
Example
 
Input
Header
string
Key Value List
Default
 
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Ignore SSL Errors (Not Recommended)
boolean
/ Required
Default
false
Notes
When this flag is enabled, SSL certificate errors will be ignored. Use this flag with caution - ignoring SSL errors presents security issues. This should only be used for testing purposes.
Example
 
Input
Include Full Response
boolean
Default
false
Notes
Enabling this flag will include the full response instead of only the returned data.
Example
 
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Query Parameter
string
Key Value List
Default
 
Notes
A 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.
Example
 
Input
Response Type
string
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
binary
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Timeout
string
Default
 
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
 
Notes
This is the URL to call.
Example
https://api.company.com/endpoint
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Output Example Payload#

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

GET Request#

Issue a HTTP GET request | key: httpGet

InputDefaultNotesExample
Input
Connection
connection
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
 
Notes
Enabling this flag will log out the current request.
Example
 
Input
Header
string
Key Value List
Default
 
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Ignore SSL Errors (Not Recommended)
boolean
/ Required
Default
false
Notes
When this flag is enabled, SSL certificate errors will be ignored. Use this flag with caution - ignoring SSL errors presents security issues. This should only be used for testing purposes.
Example
 
Input
Include Full Response
boolean
Default
false
Notes
Enabling this flag will include the full response instead of only the returned data.
Example
 
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Query Parameter
string
Key Value List
Default
 
Notes
A 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.
Example
 
Input
Response Type
string
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
binary
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Timeout
string
Default
 
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
 
Notes
This is the URL to call.
Example
https://api.company.com/endpoint
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Output Example Payload#

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

PATCH request#

Issue a HTTP PATCH request | key: httpPatch

InputDefaultNotesExample
Input
Connection
connection
Default
 
Notes
 
Example
 
Input
Data
string
/ Required
Default
 
Notes
The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
 
Notes
Enabling this flag will log out the current request.
Example
 
Input
Header
string
Key Value List
Default
 
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Ignore SSL Errors (Not Recommended)
boolean
/ Required
Default
false
Notes
When this flag is enabled, SSL certificate errors will be ignored. Use this flag with caution - ignoring SSL errors presents security issues. This should only be used for testing purposes.
Example
 
Input
Include Full Response
boolean
Default
false
Notes
Enabling this flag will include the full response instead of only the returned data.
Example
 
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Query Parameter
string
Key Value List
Default
 
Notes
A 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.
Example
 
Input
Response Type
string
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
binary
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Timeout
string
Default
 
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
 
Notes
This is the URL to call.
Example
https://api.company.com/endpoint
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Output Example Payload#

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

POST Form Data Request#

POST data as multipart/form-data. Often useful for uploading binary data. | key: httpPostFormData

InputDefaultNotesExample
Input
Connection
connection
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
 
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
Default
 
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
Default
 
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
Default
 
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Ignore SSL Errors (Not Recommended)
boolean
/ Required
Default
false
Notes
When this flag is enabled, SSL certificate errors will be ignored. Use this flag with caution - ignoring SSL errors presents security issues. This should only be used for testing purposes.
Example
 
Input
Include Full Response
boolean
Default
false
Notes
Enabling this flag will include the full response instead of only the returned data.
Example
 
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Query Parameter
string
Key Value List
Default
 
Notes
A 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.
Example
 
Input
Response Type
string
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
binary
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Timeout
string
Default
 
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
 
Notes
This is the URL to call.
Example
https://api.company.com/endpoint
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

The Post Form Data Action takes two possible inputs for data to be uploaded to an endpoint.

  • Form Data are key/value pairs. For example, "username"/"Groucho" and "accountnum"/12345. Values are turned into strings if they are not already. For more information see https://developer.mozilla.org/en-US/docs/Web/API/FormData/Using_FormData_Objects
  • File Data is similar to form data but allows you to upload file contents. A filename property is automatically generated from the key. This should be used to upload files only. All other types of data should go through the Form Data Input.

POST Request#

Issue a HTTP POST request | key: httpPost

InputDefaultNotesExample
Input
Connection
connection
Default
 
Notes
 
Example
 
Input
Data
string
/ Required
Default
 
Notes
The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
 
Notes
Enabling this flag will log out the current request.
Example
 
Input
Header
string
Key Value List
Default
 
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Ignore SSL Errors (Not Recommended)
boolean
/ Required
Default
false
Notes
When this flag is enabled, SSL certificate errors will be ignored. Use this flag with caution - ignoring SSL errors presents security issues. This should only be used for testing purposes.
Example
 
Input
Include Full Response
boolean
Default
false
Notes
Enabling this flag will include the full response instead of only the returned data.
Example
 
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Query Parameter
string
Key Value List
Default
 
Notes
A 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.
Example
 
Input
Response Type
string
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
binary
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Timeout
string
Default
 
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
 
Notes
This is the URL to call.
Example
https://api.company.com/endpoint
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Output Example Payload#

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

PUT request#

Issue a HTTP PUT request | key: httpPut

InputDefaultNotesExample
Input
Connection
connection
Default
 
Notes
 
Example
 
Input
Data
string
/ Required
Default
 
Notes
The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
 
Notes
Enabling this flag will log out the current request.
Example
 
Input
Header
string
Key Value List
Default
 
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Ignore SSL Errors (Not Recommended)
boolean
/ Required
Default
false
Notes
When this flag is enabled, SSL certificate errors will be ignored. Use this flag with caution - ignoring SSL errors presents security issues. This should only be used for testing purposes.
Example
 
Input
Include Full Response
boolean
Default
false
Notes
Enabling this flag will include the full response instead of only the returned data.
Example
 
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Query Parameter
string
Key Value List
Default
 
Notes
A 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.
Example
 
Input
Response Type
string
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
binary
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Timeout
string
Default
 
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
 
Notes
This is the URL to call.
Example
https://api.company.com/endpoint
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Output Example Payload#

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