Rest API
Connect your Copilot to external systems by pulling data from REST APIs. This allows your Copilot to access real-time data, such as updates, reports, or dynamic information from third-party services.
Connect your Copilot to external systems by pulling data from REST APIs. This integration allows your Copilot to access real-time data, such as updates, reports, or dynamic information from third-party services.
How to Set Up REST API Integration:
- Initiate Connection
-
Navigate to the Data Sources section in your dashboard.
-
Select REST API and click Connect.
-
-
Enter the required fields to set up the REST API connection.
Key Configuration Options:
-
HTTP Methods:
Choose the appropriate method based on the API's purpose:- GET: To fetch data.
- POST: To send new data (e.g., form submissions).
- PUT: To update existing data.
- DELETE: To remove data.
-
Headers:
Specify the HTTP headers required for the API, such as:- Authorization: Provide API tokens or keys for secure access.
- Content-Type: Define the data format (e.g. application/json).
- Custom Headers: Add any additional headers as required by the API.
-
Query Parameters:
Add key-value pairs to refine the request. -
Body (Optional):
For POST or PUT requests, include a JSON payload in the "Body" section, if required. Example:{
"name": "John Doe",
"email": "[email protected]",
"status": "active"
}
-
-
Click on Test Connection to validate your settings. This ensures the API integration works as expected before saving.
Make sure to store sensitive data like API keys or tokens securely, and double-check your headers and parameters for accurate configuration.