Skip to main content

API Call Node

The API Call Node enables your application to communicate with external services by making HTTP requests to specified endpoints. Use this node to fetch, send, or update data and to integrate your flows with third-party APIs.

Overview​

The API Call Node acts as a bridge between your application and external APIs, allowing you to:

  • Retrieve data from external sources
  • API Endpoint: The full URL of the API endpoint you wish to call.
  • Method: The HTTP method to use (GET, POST, PUT, DELETE).
  • Headers: Key-value pairs sent with the request (e.g., Authorization, Content-Type).
  • Payload: The request body (for methods like POST and PUT).

Outputs​

  • Response: The response data returned from the API call.
  • Status Code: The HTTP status code returned by the API.
  • Headers: The response headers.

Usage​

  • Headers Tab: Add or remove custom headers. Toggle "Protect Value" for sensitive data.
  • Payload Tab: Add fields individually or input a JSON payload for complex requests.

Example Usage​

  1. Configure Endpoint: Enter the API URL you want to call (e.g., https://api.example.com/data).
  2. Select Method: Choose from GET, POST, PUT, or DELETE.
  3. Set Headers: Add necessary headers such as authentication tokens or content types.
  4. Add Payload: For POST/PUT, fill in the payload fields or paste raw JSON.
  5. Set Timeout: Optionally, set a request timeout (e.g., 3 seconds).
  6. Save and Connect: Save your configuration and connect the node in your flow.

Tips​

  • Ensure your API endpoint is correct and accessible from your environment.
  • Use headers to provide authentication (e.g., Bearer tokens) or specify content types.
  • For complex payloads, use the JSON editor in the Payload tab.
  • Adjust timeout for APIs that may take longer to respond.
  • Use iterations for batch requests if supported by your API.

Common Use Cases​

  • Fetching data from REST APIs to display in your application
  • Sending user input or processed data to external services
  • Automating integrations with third-party platforms (e.g., Slack, Google APIs)
  • Performing CRUD operations on remote databases or services

For advanced configuration or troubleshooting, consult your platform documentation or contact support.

Basic Settings​

  • API Endpoint: The URL to which the request will be sent
    • Format: Complete URL including protocol (e.g., https://api.example.com/data)
    • Supports both HTTP and HTTPS protocols
  • Method: The HTTP method to use for the request
    • Options: GET, POST, PUT, PATCH, DELETE
    • Default: GET
  • Request Timeout: Maximum time (in seconds) to wait for a response
    • Default: 3 seconds
    • Range: 1-60 seconds

Advanced Configuration​

Click the Configure button to access additional settings:

  • Headers: Key-value pairs sent with the request
    • Common headers: Content-Type, Authorization, Accept
    • Example: Content-Type: application/json
  • Authentication: Credentials for accessing protected resources
    • Types: Basic Auth, Bearer Token, API Key
    • Configuration varies by authentication type
  • Query Parameters: URL parameters appended to the endpoint
    • Format: key-value pairs
    • Example: ?page=1&limit=10
  • Error Handling: Configure behavior when errors occur
    • Retry options
    • Fallback paths
    • Error logging

Connection Points​

The API Call Node has multiple connection points:

  • Input (left side): Receives data from previous nodes
  • Payload Input (bottom): Optional input for request body data
  • Success Output (top right, green): Connects to nodes that should execute when the API call succeeds
  • Error Output (top right, red): Connects to nodes that should execute when the API call fails

Data Handling​

Input Payload​

The payload input accepts data to be sent in the request body for methods that support it (POST, PUT, PATCH). This can be:

  • JSON objects
  • Form data
  • Raw text
  • Binary data

Output Data​

The node outputs the API response data, which can include:

  • Response body
  • Status code
  • Headers
  • Timing information