🌐

HTTP Request

Connect to external APIs
The HTTP request node allows you to make external API calls to services not yet listed in our integrations marketplace. For example you could make a request to the OpenAI API or if you would like to send an email via SendGrid you can.

Options

Connection

A reference to the connection (API Token) you would like to use within the request.

URL

The URL for the endpoint to would like to make a request to.

Method

Each method has a specific purpose, such as requesting data from a server (GET) or submitting data to a server for processing (POST) view the table below for a list of the supported HTTP methods.
Verb
Description
GET
Receive data
POST
Create new data
PUT
Update existing data
PATCH
Modify a specific portion of the data
DELETE
Delete data

Headers

A header is a piece of information included in a HTTP request that provides additional context about the content or about the client/server communication. APIs that require headers often specify this in their documentation using the notation "-H".
In most instances you will need to include an authorisation header when connecting to a third-party service. To do this you can reference the connection epecified above.
Key
Value
Authorization
Bearer {{connection.key}}

Query Parameters

A query parameter is a way to pass extra information in a HTTP request, often used to filter or sort the results.
Whilst query parameters are encrypted during transit when using HTTPS it is very poor practice to include sensitive data such as a password in query parameters especially 'GET' requests.

Body Parameters

Body parameters are not available for GET requests.
A body parameter is also a way to pass extra information in a HTTP request, unlike query parameters which are included in the URL, body parameters are sent in the requests body.
Unlike query parameters, body parameters support data types allowing you specify the type of the data included in the request. If the data passed is not in the correct format the data will be cast to the correct type or null if an exception occurs.

Cookies

A cookie is also a way to pass extra information in a HTTP request, often used to send authorisation tokens.

Caching

Caching is a technique used to store frequently accessed data in a temporary storage location, called a cache, so that it can be quickly retrieved without the need to access the original data source. This can significantly improve performance and reduce the load on the original data source.

Enable

This option enabled the cache.

Duration

This option determines the lend of time the data will be stored in the cache.

User Based Caching

Requires an active authentication integration
In addition to caching based on the query parameters defined, user-based caching ensures the data cached for one logged-in user cannot be returned to another logged-in user.

Output

Data

The response returned from the HTTP request.

Meta Data

Status code

This property equals the status code returned from the server.

Headers

This property contains the HTTP headers returned from the server.

Cookies

This property contains the cookies returned from the server.

Helpful tips

  • We recommend adding the Logic node after the HTTP request node to check for unexpected errors.
​