Skip to main content
Go to the Studio
Connections

API Request

API Request

Performs an HTTP request to an external URL, supporting the main methods (GET, POST, PUT, DELETE, OPTIONS) and allowing you to configure the headers and the body of the request.


Options​

Request URL​

Enter the full URL the request will be sent to.

Select the request method​

Select the HTTP method to be used: GET, POST, PUT, DELETE or OPTIONS.

Request body​

Enter the body of the request. Copy exactly the content expected by the destination API.

Request header​

Enter the headers necessary for the request, such as authentication tokens, content type, among others.

Returns​

Javascript code​

js
actions["action-id"].response    // API response value (Any)
actions["action-id"].status      // HTTP status code (Number)
actions["action-id"].statusText  // HTTP status text (Text)

Field selection​

  • response — API response value (Any)
  • status — numeric HTTP status code, e.g. 200, 404, 500 (Number)
  • statusText — descriptive HTTP status text, e.g. OK, Not Found (Text)

Rules and Conditions​

  • The Request URL field is required.
  • The default method is GET if no other one is selected.
  • The request body must be in the format expected by the destination API.