Freshservice (Freshworks)
Connecting Leena AI with Freshservice
The Freshservice integration syncs published articles from your Freshservice knowledge base (Solutions) into Leena AI Knowledge Management. Employees then get those articles in search results and bot answers. Setup has three parts:
- In Freshservice: Turn on the API key for an agent and copy it.
- In Freshservice: Make sure that agent can see every knowledge base folder you want to sync.
- In Leena AI KM: Add the domain and API key, choose what to sync, and run the sync.
Before you begin
You need:
- Account Admin access in Freshservice. Only an Account Admin can turn on an agent's API key.
- An agent for the integration. We recommend a dedicated full-time agent, such as "Leena AI KM", so the sync doesn't stop when an employee leaves.
- Admin access to the Leena AI Knowledge Management dashboard.
NoteLeena AI reads your knowledge base through that agent's API key. It sees exactly what the agent sees in the Freshservice agent portal, and it never writes to Freshservice.
Part 1: Turn on the API key in Freshservice
Freshservice API keys are off by default. A new agent's profile shows "Your API key is disabled. Please contact your admin to enable it."
Step 1: Open the agents list
As an Account Admin, go to Admin → Agents, or open https://<your-domain>.freshservice.com/agents.
Step 2: Edit the integration agent
Hover over the row of the agent you chose for the integration and click the Edit (pencil) icon.
Step 3: Turn on the API key
Open the Permissions tab and switch on the API key toggle. The change saves immediately.
Step 4: Copy the API key
- Sign in to Freshservice as the integration agent.
- Click the profile picture (top right) → Profile Settings.
- In the Your API Key panel, click Show API Key and copy the key.
ImportantTreat the API key like a password and store it securely. If you click Reset API Key later, the old key stops working and you must update it in Leena AI (Part 3).
Step 5: Note your Freshservice domain
Copy the address you use to open Freshservice, for example https://acme.freshservice.com.
Part 2: Give the agent access to your knowledge base
Leena AI can only sync folders the integration agent can see. You don't share anything with Leena AI directly. Instead, give the agent access in Freshservice.
Step 1: Add the agent to each workspace
If your account has more than one workspace (for example IT and HR), give the agent access to every workspace whose knowledge base you want to sync. If a workspace is restricted, the agent must be a member of it.
Step 2: Add the agent to restricted agent groups
If a folder's visibility is set to Agent groups, add the agent to at least one of the groups listed on that folder. Otherwise the agent can't see the folder.
Step 3: Check what the agent can see
Sign in as the integration agent and open Knowledge Base. Every category, folder and sub-folder shown there is what Leena AI will find.
TipLeena AI only syncs folders you select in Part 3. Giving the agent wide access doesn't sync everything; it only makes those folders available to pick.
Part 3: Configure the integration in Leena AI
Step 1: Open the integration settings
In the Leena AI Knowledge Management dashboard, go to Settings → Integrations → Freshservice. The Connect Freshservice setup has two stages: Add credentials and Configure metadata.
Step 2: Enter the connection details
| Field | What to enter |
|---|---|
| Connection name | A label for this connection, for example "Freshservice Production". |
| Freshservice domain | Your domain from Part 1, Step 5. acme, acme.freshservice.com and https://acme.freshservice.com are all accepted. |
| API key | The key copied in Part 1, Step 4. It is masked as you type, and after saving only its last 4 characters are shown. |
Click Test connection. When it passes, you see "Connected — N categories found", and the remaining fields unlock:
| Field | What to choose |
|---|---|
| Workspace | All workspaces (default) or one workspace. |
| Audience | Fetch from Freshservice (default): each article is shown only to employees who can read it in Freshservice. Public: every synced article is shown to all employees. |
Step 3: Configure article settings
- Move articles to: Choose Publish to make synced articles live right away, or Draft to review them in KM before publishing.
- Expiry window: Optional. Sets how long synced articles stay valid in KM.
Click Save and next. You can click Save as draft at any point and finish later.
Step 4: Choose categories and folders
Select the categories and folders to sync. Sub-folders appear under their folder and are included with it. Select at least one category.
Step 5: Configure metadata filters (optional)
Skip this step to sync every published article in the folders you selected.
- Based on document path: Choose Include filter to sync only the folder paths you add, or Exclude filter to sync everything selected except those paths. Enter paths as
Category/Folder/Sub-folder, for exampleIT/Network/VPN. Click + Add path to add more. - Based on metadata: Add a row with a metadata name, a condition and a value, and choose include or exclude. All rows must match for an article to sync.
- Based on expiration date: Turn on to skip articles whose Freshservice Review date has passed. Articles already in KM are removed once their review date passes.
| Metadata | Conditions | Values |
|---|---|---|
| Tags | is any of, is not any of, contains all, is empty, is not empty | Tags on your synced articles |
| Keywords | is any of, is not any of, contains all, is empty, is not empty | Keywords on your synced articles |
| Article type | is, is not | Permanent, Workaround |
| Created date, Modified date, Review date | on, before, after | A date |
NoteThe Tags and Keywords value lists fill in after the first sync. Before then, type the values yourself. A Tags filter also makes the first sync slower, because Leena AI must open each article to read its tags.
Step 6: Connect and run the sync
Click Connect to save the integration and start the first sync. When it finishes, your Freshservice articles appear in the Leena AI Knowledge Management dashboard.
Who can see synced articles
With Audience set to Fetch from Freshservice, Leena AI never shows an article to more people than Freshservice does. The audience comes from the visibility of the article's folder:
| Freshservice folder visibility | Who gets the article in Leena AI |
|---|---|
| All | Every employee |
| Logged in Users | Active Freshservice agents and requesters |
| Agents Only | Active agents |
| Departments | Agents and requesters in the listed departments |
| Agent groups | Members of the listed agent groups |
| Contact groups | Members of the listed requester groups |
- Sub-folders follow their top-level folder's visibility.
- People are matched to Leena AI employees by email address.
- In a restricted workspace, only agents who are members of that workspace get its articles.
- If Leena AI can't work out who may read a folder (for example, a group with no members returned), it doesn't sync that folder's articles, and the sync shows as Partially completed.
- Changes to a folder's visibility or group members apply at the next sync.
What gets synced
- Synced: Published articles in the selected categories, folders and sub-folders (any depth), with their attachments and inline images.
- Not synced: Drafts, articles waiting for approval, tickets and the service catalog.
- Updates: Edits, moves and deletions in Freshservice reach Leena AI at the next sync.
- Drafts of published articles: If someone saves a draft of a published article without publishing it, Leena AI keeps the published version until the new version is published.
Troubleshooting
| Message | What to do |
|---|---|
| "API key invalid or disabled" | Ask your Freshservice Account Admin to turn on the API key for the agent (Part 1, Step 3), or paste the current key if it was reset. |
| "Domain not found" | Check the domain. It must end in .freshservice.com. |
| "Connected, but this agent can't see any knowledge base content" | Give the agent access to the workspaces and folders (Part 2). |
| Sync status Partially completed | Open the sync log to see which category, folder or article failed. Failed items are retried at the next sync. |
Quick reference
| Value | Where to get it | Format example |
|---|---|---|
| Freshservice domain | The address you use to open Freshservice | acme.freshservice.com |
| API key | Freshservice → profile picture → Profile Settings → Your API Key → Show API Key (signed in as the integration agent) | A string of letters and numbers |
| Turn on the API key | Freshservice → Admin → Agents → edit the agent → Permissions → API key | Toggle |
| Folder path (optional filter) | Category, folder and sub-folder names from Freshservice Knowledge Base | IT/Network/VPN |
Updated about 12 hours ago
