Prerequisites
- A Freshservice account with API access
- Access to the Search AI application
Step 1: Generate an API Key in Freshservice
- Sign in to your Freshservice account.
- Click your profile initials in the top-right corner of the dashboard and select Profile Settings.
- In Profile Settings, find the API Key section and copy the key. Store it securely.
If the API key is not visible or is disabled, ensure your user role has the necessary permissions. An admin can enable this under agent permissions.
Step 2: Configure the Freshservice Connector in Search AI
- In Search AI, go to the Authorization page of the Freshservice connector.
-
Provide the following fields and click Connect:
Content Ingestion
After connecting, go to the Configuration tab to set up synchronization:- Sync Now — triggers an immediate sync.
- Schedule Sync — sets up automatic sync on a recurring schedule.
Articles in sub-folders within a folder are not supported.
RACL Support
Article visibility in Search AI reflects the folder-level visibility settings in Freshservice. All files within a folder inherit the folder’s visibility configuration.Users associated with a group in Freshservice are automatically added to the corresponding permission entity in Search AI. If group membership changes after ingestion, use the Permission Entity APIs to update the associations.
sys_racl field: