Docs

Integrations / Knowledge

Freshservice Service Catalogs

Index your Freshservice service catalog items so Risotto can point employees to the right item

The Freshservice Service Catalogs index makes the items in your Freshservice service catalog searchable in Risotto. When an employee asks for something that your catalog offers, Risotto can answer with the item name, its description, and a link to request it.

You create this index in Knowledge → Indexes.

How it works

  1. Risotto reads the service catalog items of one Freshservice workspace.
  2. Risotto skips items with the Draft visibility and items that are deleted.
  3. For each item, Risotto indexes the name, the description, and a link to the item in your Freshservice portal.
  4. When an answer uses an item, Risotto links to the item at <URL>/support/catalog/items/<item ID>.

Prerequisites

  • A Freshservice API key for an account that can see the service catalog. See Choose the account for the API key.
  • The URL of your Freshservice instance (for example, https://mycompany.freshservice.com)
  • The ID of the workspace that contains the catalog. Use the number, not the workspace name.

To get the API key and the workspace ID, follow Step 1 of the Freshservice Knowledge Base setup.

Create the index

  1. Open Indexes

    In your Risotto dashboard, go to Knowledge → Indexes.

  2. Choose the data source

    Click Create index. For Data source, select Freshservice Service Catalogs.

  3. Enter the settings

    • Index name: A unique name for this index (for example, IT Catalog)
    • API key: A vault credential that holds your Freshservice API key
    • URL: Your Freshservice instance URL
    • Workspace ID: The ID of the workspace that contains the catalog (for example, 2)
    • Audience, Department, and Profile filters (optional): Choose who gets answers from this index. See Indexes.
  4. Create the index

    Click Create. The Indexing Jobs panel on the Indexes page shows the progress.

Create index is the only way to add a service catalog index: the Freshservice integration page has no add button for one. Once the index exists, it also shows in the Service catalogs section of Settings > Integrations > Freshservice > Knowledge, where you can reindex or remove it.

Reindex

Risotto does not reindex the catalog automatically. After you add, change, or publish catalog items, click the row's ⋮ menu (Index actions), then click Reindex.

Troubleshooting

The index fails with "No service catalog items found"

Risotto found no published items in the workspace. Make sure that the Workspace ID is the ID of the workspace that contains your catalog. Make sure that the items are not in the Draft visibility.

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. Make sure that the URL and the API key are correct. Make sure that the Workspace ID is a number from the workspace URL, not the workspace name.

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