Setup - Highspot

Overview

This guide is self-contained — every permission and capability required is listed in the steps below. For why each is needed, alternative permission models, and the full security and permission-propagation details, see Permissions & Security - Highspot.

Prerequisites

Who you need to be

• Access to a paid Highspot license where API access can be enabled (contact Highspot Support if API is not already available)

• Ability to generate a Highspot API Client Key and Client Secret (or access to an admin who can)

• Ability to request Impersonation on the API client from Highspot Support if you plan to use Spot-level permissions

• Simpplr admin access to configure Enterprise Search sources

Network and firewall

• Outbound HTTPS access from Simpplr to your Highspot API host (instance-specific; for example https://api-su2.highspot.com or https://api.highspot.com)

Step 1 — Prepare Highspot

Credentials you will need from Highspot

• Highspot API Base URL (host + version path)

• Client Key

• Client Secret

• Domain of your Highspot Instance

1. Contact Highspot Support to enable API functionality for your Highspot instance (if not already enabled) without which you will not be able to see Developer Section in the Highspot Settings.

2. Sign in to Highspot and open User Profile → Settings → Developer → Basic.

   

3. Copy the API URL for your instance (host and version may vary by tenant).

4. Generate the API Key (Client Key) and Secret; store them securely.

5. Grant the API client the capabilities needed for this connector (see Permissions & Security - Highspot for why each is needed):

   • Client Key and Client Secret for read-only API access

   • Impersonation enabled on the same API client (recommended for Spot-level permissions — request via Highspot Support

6. Enable user impersonation via User profile → Settings → Developer → Basic. Refer to the screenshot above.

7. Prefer a dedicated Highspot user for the API key whose Spot access matches the crawl scope you want when Spot-level permissions are off.

8. Your domain is the text immediately before .highspot.com in your browser's URL. For example, in https://simpplr-test.highspot.com/ the domain is simpplr-test.

Step 2 — Add Highspot as a source in Simpplr Enterprise Search Admin Panel

1. In Simpplr, go to: Manage features → Enterprise search → Add source.

   

2. Search for and select Highspot.

3. Enter a Connection Name for this instance.

4. Enter the credentials from Step 1:

   • Highspot API Base URL

   • Client Key

   • Client Secret

   • Domain Of Your Highspot Instance

     

5. Configure permission options:

   • Disable User Impersonation — leave off (unchecked) to use Spot-level permissions via Impersonation. Leave on only if Impersonation is unavailable and you accept API-key crawl scope with broadly searchable indexed content.

6. Click Save configuration and confirm.

Step 3 — Add filters and ingestion scope

Filters control which content gets indexed. All filters are optional — if none are set, all accessible Spots and Items in crawl scope are indexed (subject to document age defaults if configured).

1. Set filters — configure which content to include or exclude from indexing.

   Spot-based filters

   • Include specific Spots: index only selected Spots (and their Items).

   • Exclude specific Spots: skip selected Spots and their Items.

   Exclude unofficial Spots

   • When enabled, unofficial/personal Spots are skipped. When disabled (default), unofficial Spots are included.

   Common filters

   • Document age (limit Items by created/updated date)

   

2. Set Audience configuration (optional) — restrict the connector to a specific Simpplr audience. Only members of the selected audience will be able to find this content in Enterprise Search. If left unset, all users with access can search this content.

3. Click Save and sync — this saves the configuration and initiates the first full sync.

   Alternatively, click Exit to save and resume setup later. To start the sync manually, go to Enterprise Search → Highspot → Status and click Sync now.

Step 4 — Verify the sync

1. Monitor progress at: Enterprise Search → Highspot → Status.

2. The dashboard shows sync status, total items indexed, and any errors.
   

What success looks like:

• Shortly after the connector is initialised, the status shows In progress and the item count begins increasing.

• When the initial full sync completes, the status shows Success and Highspot Spot/Item results appear in Enterprise Search for users with access.

• Initial full sync duration depends on content volume and, when Spot-level permissions are on, the number of active users (Impersonation walks) — large tenants can take several hours.

If the sync stays in Pending, fails, or completes with far fewer items than expected, see Troubleshooting - Enterprise Search Connectors and Troubleshooting & FAQs - Highspot.