Web API
Version: 3.1.0
Web API integration allows you to execute any Web API and retrieve results.
Connect Web API with LogicHub
- Navigate to Automations > Integrations.
- Search for Web API.
- Click Details, then the + icon. Enter the required information in the following fields.
- Label: Enter a connection name.
- Reference Values: Define variables here to templatize integration connections and actions. For example, you can use https://www.{{hostname}}.com where, hostname is a variable defined in this input. For more information on how to add data, see 'Add Data' Input Type for Integrations.
- Verify SSL: Select option to verify connecting server's SSL certificate (Default is Verify SSL Certificate).
- Remote Agent: Run this integration using the LogicHub Remote Agent.
- Client Certificate: Upload a .p12 Client Certificate file (p12 file at action input takes precedence over connection).
- Client Certificate Password: Enter password to read the client certificate.
- After you've entered all the details, click Connect.
Actions for Web API
Execute Web API
Execute the given Web API and return the response.
Input Field
Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.
Input Name | Description | Required |
---|---|---|
Request Type | GET/POST/PUT/PATCH/DELETE | Required |
URL | Jinja-templated Url Endpoint. | Required |
Headers | Jinja-templated Web api request headers | Optional |
Params | Jinja-templated Web api request parameters. | Optional |
Body | Jinja-templated Web api request body | Optional |
Username | Username for request. | Optional |
Password | Password for request. | Optional |
Client Certificate | Upload a .p12 Client Certificate file. | Optional |
Client Certificate Password | Enter the password to read the client certificate. | Optional |
Expected Response Format | Select how to parse the response based on its expected format. Raw/CSV/HTML/JSON/File. (Default is "Raw" and will pass the full body to the response field). | Optional |
Explode Results | If server response is parsed as a list of values instead of a single value, return as individual rows for each value (Default is False). | Optional |
Output
A JSON object containing multiple rows of result:
- has_error: True/False
- error: message/null
- other keys of JSON response
Updated 6 months ago