Skip to main content

​
Node Description

The API Connector is a versatile tool for making HTTP requests to external APIs, enabling data retrieval or updates in JSON or other formats. This tool supports dynamic input parameters.

​
Node Inputs

​
Required Fields

  1. Method
    HTTP method to execute. Options:
    • GET: Retrieve data.
    • POST: Send data to the server.
    • PUT: Update existing resources.
    • DELETE: Remove resources.
      Example: "GET"
  2. URL
    The endpoint URL of the API.
    Example: "https://api.example.com/data"

​
Optional Fields

  1. Authorization
    Custom headers for sensitive values like API key or tokens required for secured access.
    Example: "Bearer YOUR_API_KEY" The values will be masked and not shared to end-users after the initial save of the value. The values will be displayed as *** and other users won’t be able to read the value.
  2. Headers
    Custom headers to include in the request.
    Example:     
    {
  "Content-Type": "application/json",
  "Accept": "application/json"
}
  3. Content Type
    Specifies the format of the request body.
    Options:
    • JSON (default)
    • Form Data
    • Raw Text
  4. Parameters
    Query string parameters for GET requests or body payload for POST/PUT requests.
    Example for GET:     
    {
  "userId": 123
}
    Example for POST: 
    {
  "name": "John Doe",
  "email": "john@example.com"
}

​
Node Output

The API Connector returns the following output details in JSON format:
  1. Body:
    • Type: string | object | blob
    • Content of the API response.
      Example:
    {
  "data": [
    { "id": 1, "name": "Alice" },
    { "id": 2, "name": "Bob" }
  ]
}
  2. Headers:
    • Type: object
    • Headers of the API response.
      Example:
    {
  "Content-Type": "application/json",
  "Date": "Mon, 20 Nov 2024 10:00:00 GMT"
}
  3. Status Code:
    • Type: number
    • HTTP status code of the response.
      Example: 200
The API Connector is an essential tool for integrating external APIs, automating workflows, and connecting your application with other services.