The HTTP Request block

HTTP Request block

The HTTP Request block runs an HTTP request that you select from a collection and sends the result from its output port.

Input

Send - If you connect another block to this input port, that block triggers the HTTP Request block to run. This connection is optional. The HTTP Request block will run when the flow runs, even if this port isn't connected to another block.

Outputs

Success - Sends the response of a successful API request. A successful request has a 2xx HTTP status code.

Fail - Sends the response of an unsuccessful API request. An unsuccessful request has an HTTP status code other than 2xx.

Setup

Select a request - Select this dropdown list to see all the collections in your workspace. Select a collection, then select an HTTP request.

Variables - If the selected request has one or more variables, they'll be listed here. You can assign a value to a variable by connecting another block's output port to the variable's input port. You can also assign a value to a variable by inserting a data block with Add icon Add data blocks. If your request uses environment variables, you can select the environment from the Add environment dropdown list.

Specify how to parse the response

The HTTP Request block can parse its response as JSON, XML, HTML, or text.

To choose how to parse the response, do the following:

  1. Select the HTTP Request block, then select Additional Settings Additional Settings.

  2. Select Parse Response Parse Response.

  3. Select a format from the dropdown list. You can also select Auto to let the HTTP Request block decide how to parse the response. The default setting is Auto.

The Select and Evaluate blocks are often connected to the HTTP Request block. The Select block is useful for extracting specific information from a response. The Evaluate block is useful for transforming response data and creating conditions to route data in your flow based on a response.

Last modified: 2025/01/22