Basic Configuration

Configuring Basic Configuration of API Call

Field Purpose: This field allows you to define a short and clear description of the API request. The description helps others understand the purpose of the API call and its function within the system.
How to Configure:
- Provide a brief description that explains the action this API call will perform.
- Example: “Retrieve customer details based on the provided user ID.”

Field Purpose: Here, you describe the conditions or triggers that will cause the API call to be executed. This could be based on user actions, specific events, or data from the conversation.
How to Configure:
- Define the condition that must be met for the API call to occur.
- Example: “When the user submits their user ID, this API call will fetch their account details.”
API Basic Configuration - Condition

Field Purpose: The URL field is used to define the endpoint of the API you want to connect with. This is where the system will send the request to retrieve or send data.
How to Configure:
- Enter the full API URL (including parameters if necessary).
- Example: “https://api.example.com/v1/customer/details?userID=123”
  API Basic Configuration - URL

Field Purpose: This setting specifies the HTTP method used for the API call. In this case, the API is exclusively used to retrieve data, and the only available method is GET.
Available Method:
- GET – Used exclusively to retrieve data from external sources.
How to Configure:
- Since this API is designed solely for data retrieval, the GET method is preselected and must be used for all API calls. No other HTTP methods (e.g., POST, PUT, DELETE) are allowed in this configuration.
Example:
- For retrieving customer details or product information, the GET method will be used to fetch the necessary data from the external API.

Last updated 8 months ago