Skip to main content
The API Node allows your workflow to call external web services using standard HTTP requests. It is ideal for fetching data, triggering backend actions, integrating with third-party systems, or enriching your automation with external data. API Nodes support configurable methods, headers, bodies, authentication, and flexible response handling.

HTTP Methods

GET, POST, PUT, DELETE, PATCH

Custom Headers

Add headers to the request

Request Body

Send JSON payloads

Response Processing

Automatically parse response

Configuration

Method & URL

Method: Select the HTTP method to use (GET, POST, PUT, DELETE, PATCH, etc.) URL: Enter the full endpoint you want to call. You may reference dynamic variables inside the URL path or query string.

Headers

Add custom headers to your request. Common examples:
  • Content-Type: typically application/json
  • Authorization: Bearer tokens or API keys
  • Accept: the expected response format
  • User-Agent: custom user agent strings

Body

Define the request body for POST, PUT, and PATCH requests. Supported formats:
  • JSON — structured objects
  • Form Data — form-encoded or multipart
  • Raw — plain text or custom payloads
You may reference dynamic variables inside the body. Example JSON body:
{
  "name": "John Doe",
  "email": "john.doe@gmail.com"
}

Response Handling

Success Responses

Responses with status codes 200–299 are considered successful.
  • JSON is automatically parsed into objects
  • Text responses are passed as strings
  • Returned data becomes available to subsequent nodes

Error Handling

Errors may occur due to:
  • Network failures or timeouts
  • HTTP error status codes (400–599)
  • Invalid JSON responses
  • API-specific error messages

Common Examples

GET Request — Fetch Product Details

Method: GET
URL: https://api.store.com/products/12345
Headers:
  Authorization: Bearer <token>
  Accept: application/json

POST Request — Create a New Product

Method: POST
URL: https://api.store.com/products
Headers:
  Authorization: Bearer <token>
  Content-Type: application/json
Body:
{
  "name": "Wireless Headphones",
  "price": 99.99,
  "category": "electronics",
  "in_stock": true
}
Test your API endpoints independently before integrating them into an API Node. This ensures authentication, request bodies, and headers work before running them inside a workflow.