Skip to main content
Version: 1.5.x

API Request

A API Request function in a workflow performs an HTTP request, retrieving data from an external source. The data returned from this HTTP request is then merged with the original trigger data provided when the workflow was initiated.

Adding API Request Function​

API Request function can be added at any point in your workflow. They can occur before or after any function/step

Configuring a request​

After adding a API Request function in the workflow builder, you can configure the specifics of your request using the edit request option. For each API Request step, you can adjust the following attributes:

  1. Request method: Choose from GET (the default), POST, or PUT.
  2. URL: Provide a valid HTTP URL.
  3. Headers: Specify any headers to include in the request using a key-value editor, where the key is the header name and the value is the header value.
  4. Query parameters: Add any query parameters to encode into the URL using a key-value editor.
  5. Request body: For POST or PUT requests, build a request body to include in the request. The request body will always be encoded as JSON.
tip

You have the flexibility to create conditions for API Request step using the Condition Builder.