Skip to main content

Send HTTP Request

Sophie avatar
Written by Sophie
Updated over a week ago

Definition and Usage

Send an HTTP request and save the response as a variable or file. This command allows you to make API calls using various HTTP methods and process the returned data within your workflow.


Parameter Values

Input parameters

Parameter

Description

Possible Values

Required

Options / Notes

Method

Select the HTTP method

Get, Post, Put, Delete, Options

Yes

Determines the type of request to be sent

URL

Enter the request URL

Yes

The endpoint URL to which the request will be sent

Headers

No

Key-value pairs for HTTP headers

Body

Enter the request body content

No

Required for POST and PUT requests

Store response into

Store the response in a new variable

Yes

Variable that will contain the HTTP response

Advanced settings

Parameter

Description

Possible Values

Required

Options / Notes

Timeout (s)

Set the timeout in seconds

No

Default is 30 seconds

Save as file

Save the response as a file instead of a variable

Boolean

No

When checked, response will be saved locally

Folder

Select a folder to save the file

No*

File name

Enter file name

No*

*Required when "Save as file" is enabled

Error handling

Parameter Name

Description

Throw error & stop

When an error occurs, the action will trigger an error and stop the execution of the entire app.

Retry command

If an error occurs, the action will retry the command in an attempt to resolve the issue and continue the process.

Ignore error & continue

When an error occurs, the action will be ignored, and the workflow will continue without interruption.

Variables produced

This action produces a variable containing the HTTP response data. The response can be stored as a variable for following actions.


Using Variables in Conditions

You can use variables in the URL, Headers, and Body parameters by inserting them with the {variableName} syntax. This allows you to dynamically construct requests based on data from previous steps in your workflow.

For example, you can use a previously defined variable in the URL field like: https://api.example.com/users/{userId}


Notes

  • For POST and PUT requests, ensure the Body parameter is correctly formatted according to the API requirements (JSON, XML, form data, etc.)

  • Headers should be added as key-value pairs to properly authenticate or format your request

  • When using "Save as file" option, make sure the destination folder exists and is accessible

  • HTTP responses may contain different status codes; consider handling these appropriately in your workflow

  • For large responses, consider using the "Save as file" option

Did this answer your question?