API
Learn about API nodes and their HTTP request capabilities
The API node executes HTTP requests to external APIs and web services. It provides flexible configuration for making GET, POST, PUT, DELETE, and other HTTP requests with custom headers, bodies, and authentication.
HTTP Methods
Support for all standard HTTP methods (GET, POST, PUT, DELETE, etc.)
Custom Headers
Configure custom headers for authentication and content types
Request Body
Send JSON, form data, or raw content in request bodies
Response Processing
Automatically parse and process API responses
Configuration Options
Basic Settings
Name
Name
Set a descriptive name for your API node. This helps identify the node’s purpose in your workflow.
Description
Description
Provide a clear description of what this API request will accomplish.
Request Configuration
Method & URL
Method & URL
Method: Select the HTTP method from the dropdown (GET, POST, PUT, DELETE, PATCH, etc.)
URL: Enter the full URL endpoint for your API request. You can use variables in the URL path.
Headers
Headers
Configure custom headers for your request:
- Content-Type: Set to
application/json
for JSON data - Authorization: Add Bearer tokens or API keys
- User-Agent: Custom user agent strings
- Accept: Specify expected response format
Body
Body
The request body for POST, PUT, and PATCH requests:
- JSON: Send structured data as JSON
- Form Data: Send form-encoded data
- Raw: Send plain text or custom formatted data
Example JSON body:
Response Handling
Success Responses
Status Codes: 200-299 range considered successful
- Response data automatically parsed
- JSON responses converted to objects
- Text responses passed as strings
- Response available for next nodes
Error Handling
Error Conditions:
- Network timeouts and connection errors
- HTTP error status codes (400-599)
- Invalid JSON responses
- Custom error handling based on response content
Common Examples
GET Request - Fetch Product Details
POST Request - Create New Product
Test your API endpoints independently before integrating them into your workflow to ensure proper authentication and data formatting.