You can use the Call API automation to access functionality or retrieve data from the other tools and products you and your team use. For example, your workflow might call a weather API to retrieve current weather data for a specific location, or call your payment service API to process a customer's payment.
Calling an API refers to the process of making a request to a another product in order to retrieve data or perform a specific action. This enables your Onalu workflow to automatically interact with different software systems or applications.
When you call an API, you send a request containing specific parameters or data to the API endpoint. The API endpoint is a specific URL that serves as the entry point for accessing the API. Our API automation supports HTTP request methods GET, POST, PUT, PATCH, and DELETE. Once the API has processed the request, it will send back a response, which contains the requested data or an acknowledgment of the performed action. You can map the response from the API to return a value from this automation which can be referenced elsewhere in your workflow.
💡Tip: It helps to have the API documentation for the API that you want to call handy as you configure these settings.
The Call API automation supports HTTP request methods (GET, POST, PUT, PATCH, DELETE)
Select the URL of the API endpoint that serves as the entry point for accessing the API.
Headers are additional pieces of information sent along with the API request. Headers provide metadata about the API request, allowing the client and server to communicate important details and instructions.
Used to authenticate and authorize the API request. It typically contains authentication credentials, such as an API key, access token, or a bearer token, to validate the user or application making the request.
The Call API automation supports JSON payloads. Enter the JSON payload you want to send here.
💡 Tip: Use references to insert dynamic data into your API Request
Mapping the API response is optional. If you do not map a response, the value of the automation will always return an <empty value>, even after the API call was completed.
You can map the API response so that you can use the response from the API in your Onalu table.
JMESPath is a query language and syntax for searching and extracting data from JSON-like structures. It stands for "JSON Matching Expression Path." JMESPath allows you to specify a query expression to traverse and filter data in JSON documents, making it easier to retrieve specific information from complex data structures.
For each piece of data you wish to capture:
1. Select the type: Use the dropdown to select the type that best describes the data sent in the response.
2. Set property name: Type in a name for the mapped data property that best describes what the data is in case you need to reference it in another field or formula.