API Endpoint Definition and Integration Guide

API Integrations and Connectors Guide

Our platform offers a secure API Connector infrastructure that allows your assistant to communicate with your internal software (CRM, ERP, e-commerce).

Defining an API Connector

Go to the API Integrations tab in your company panel. Create a connection using the "Add New Integration" button:

1. Basic Info: Define an integration name and a base URL.
2. API Authentication (Auth) Methods: Select one of the following authentication models based on your external server's security structure:
   • Bearer Token: Appends the token in the HTTP Header as Authorization: Bearer [token].
   • API Key: Sends a custom key as a Header or Query string.
   • Basic Auth: Sends username and password encoded in Base64 format.

Defining Endpoints and Parameters

You can define multiple API Endpoints (e.g., /orders/search, /customers/detail) under a single integration. For each endpoint:

• Select the HTTP Method (GET, POST, PUT, DELETE).
• Define Request parameters with their data types.
• Map Response parameters to guide the AI on which JSON fields (e.g., status, delivery_date) it should read.

Webhook Triggering Mechanism

You can define a Webhook to notify your external systems when your assistant replies to an email or a critical chat ends. The webhook data is POSTed to your receiver server in a secure JSON payload format.