The HTTP Step allows you to make API calls, send data, and process responses from external systems.
When to Use
- Retrieve data from APIs
- Send data to external systems
- Authenticate with external services
- Download files from web servers
Settings Overview
Request Tab
- Description: Add a clear purpose for this step
- Source: Select a configured system or “Custom Request”
- Method: GET, POST, PUT, PATCH, DELETE
- URL: Supports parameters like
{{$.variable}} - Parameters: Automatically detected from URL
- Test Buttons: Test only this step, or the flow up to this step
Headers Tab
- Content-Type: Set for POST/PUT (e.g., JSON, XML)
- Custom Headers: Add authentication or custom headers
Pagination Tab
- Configure if API returns paginated data
- Set page size and number parameters
Response Tab
- Select which HTTP status codes are “success”
- Choose response data format: JSON, CSV, XML, YAML
- Extract IDs from Location headers
- Use JSONPath to extract specific response data
Input/Output Tabs
- Input: View incoming data
- Body: Build request body visually
- Response: Preview API response
- Output: See processed output data
Tips
Use the “Editor preview” toggle for debugging step data
Use system dropdown to access pre-configured endpoints
Use the “Manage Search” icon to browse endpoint templates
Test using the “Play” button
Map previous step data to your POST/PUT body
Enable pagination for large datasets