Purpose
Use HTTP/API Request to bring API data into a workflow or send a request to a service without driving its website through browser clicks.
How it works
- Sends a request to the configured API endpoint.
- Supports request headers, authentication, and a body.
- Makes the API response available as data for the workflow.
Configuration fields
| Field | Required | Default | Description |
|---|---|---|---|
| URL | Yes | - | The API endpoint to call, for example https://api.example.com/products. |
| Method | Yes | - | The HTTP method required by the endpoint, such as GET for reading data or POST for submitting it. |
| Headers | No | - | Headers required by the API, such as Accept and Content-Type. |
| Authentication | No | - | Credentials required by the endpoint. Use the authentication options available in the desktop app. |
| Body | No | - | The payload to send when the endpoint expects a request body. |
Output
The API response, available as workflow data.
Usage notes
- Start with a simple read-only endpoint and inspect its response before adding it to a larger workflow.
- Match the method, headers, authentication, and body to the API's documentation.
- Check the response status and content: an error response is different from a successful response with no records.
- Use Network/XHR Capture to inspect requests generated by the browser, and HTTP/API Request to send an explicitly configured request.
Windows 11
macOS 12+