Docs

Integrations / Knowledge

Freshservice Tickets

Index and search Freshservice Tickets in Risotto

Connect your Freshservice workspace to Risotto to make solved tickets content searchable through the AI assistant.

Prerequisites

Before setting up the Freshservice Tickets integration, ensure you have:

  1. API Key: a Freshservice API key. The account that owns the key needs an agent role in the workspace, with the access level Across the workspace. An admin role alone cannot read tickets. See Choose the account for the API key.
  2. The Freshservice URL: the URL for the Freshservice instance (e.g. https://mycompany.freshservice.com)
  3. Workspace ID: the number of the workspace that contains the tickets. Use the number, not the workspace name.

Setup Process

Step 1: Get Freshservice API Key

  1. Go to your Freshservice instance.

  2. Go to your Profile settings

    Click on your profile picture (top-left) and choose "Profile settings"

  3. Copy your API Key

    On the right side you should see "Your API Key". Reveal it, copy it and store it.

  4. Copy your Workspace ID

    In Freshservice go to:

    Admin -> Manage Workspaces -> Click on the Workspace from the list

    This will take you to a URL that looks like: https://mycompany.freshservice.com/a/admin/workspaces/2/edit

    The ID of the Workspace in the example is 2. Enter this number, not the workspace name.

Step 2: Configure Integration in Risotto

  1. Open Freshservice's page

    Go to Settings → Integrations → Freshservice and open the Knowledge tab. In the Tickets section, click Add workspace. The Index tickets dialog opens.

  2. Configure the Index

    Enter the following required information:

    • Site URL: Your Freshservice instance URL (e.g. https://mycompany.freshservice.com). Risotto fills it in from your Freshservice connection when there is one. Start it with https://.

    • Workspace ID: The Workspace ID (e.g. 2)

    • API key: A vault credential that holds your Freshservice API key

    • Agent groups (Optional): The names of Agent Groups you want to scope this index to (e.g. IT Agents, Network Group)

      This configuration allows you to only index workspace tickets assigned to specific Agent Groups. When left empty Risotto will index all of tickets from the workspace. Each name must match the group name in Freshservice exactly, including uppercase and lowercase letters.

    • Created since (Optional): Risotto indexes only the tickets created since this date. Use the format YYYY-MM-DD (e.g. 2023-01-01). To index older tickets, enter an earlier date.

    • Department and Audience: Choose who gets answers from this index. See Indexes.

  3. Create and Monitor Index

    1. Click Index tickets
    2. Watch the workspace's card on the Knowledge tab, or the Indexing Jobs panel on Knowledge > Indexes
    3. Wait for completion before expecting search results

Create index on Knowledge > Indexes still adds a Freshservice Tickets index with the same details plus an Index name. It is the only place to set Profile filters.


Content Considerations

  • Risotto indexes only tickets with the Resolved or Closed status.
  • Risotto indexes only tickets created since the Created since date.
  • For each ticket, Risotto indexes the subject, the description, the public replies, and the resolution notes.
  • Risotto does not index private notes.

Monitoring Index Health

  • Check the Indexing Jobs panel above the indexes table. A running job shows its progress there. A failed job stays there with its error message and a retry button.
  • Check the Count column of the index to verify that the expected content was captured

Reindexing Content

To update your index with the latest changes:

  1. Navigate to Knowledge → Indexes
  2. Find your Freshservice Tickets index
  3. Click the row's ⋮ menu (Index actions), then click Reindex to pull the latest changes
  4. Monitor progress until completion

Content Verification

After indexing, test that your content is searchable:

  • Use Knowledge → Playground to test queries
  • Ask questions that should be answered using your indexed content
  • Verify that Risotto can find and reference your indexed tickets

Troubleshooting

The index fails with "Agent group ... not found"

Risotto did not find a group with this name in the workspace. Make sure that each name in Agent groups matches the group name in Freshservice exactly, including uppercase and lowercase letters. Separate the names with commas.

The index fails with "Server error while getting workspace"

Freshservice refused a request from Risotto. Risotto shows this message for every refused request, also when the cause is a wrong setting. Do not retry with the same settings. Check these causes:

  • The Workspace ID is the workspace name or a number that does not exist. Enter the number from the workspace URL.
  • The account that owns the API key has no agent role in the workspace, or its access level is narrower than Across the workspace. See Choose the account for the API key.
  • The Site URL or the API key is wrong.
Older tickets are missing from search results

Risotto indexes only the tickets created since the Created since date. You cannot change this date on an existing index. Create a new index with an earlier date, then delete the old index.

Something wrong or missing? Report an issue · View as Markdown