Supported Features and Limitations
The Highspot connector is designed to ingest and index content from Highspot, making it searchable within Glean. This section outlines the supported objects, API endpoints, limitations, crawling strategy, and how results are displayed.Supported Objects/Entities
| Object/Entity | Description |
|---|---|
| Spots | All Spots accessible to the API user |
| Items | All Items within accessible Spots. For iteams, Glean crawls content and metadata. |
Supported API Endpoints/Features
/users: Fetches users from Highspot./spots: Fetches Spots. In content crawl, this endpoint can be used to retrieve all spots across the tenant. Optionally, results can be scoped per user by using impersonation to apply that user’s permissions./items/%s: Lists items within a Spot, including metadata./items/%s/content: Downloads the content of a given item.
Limitations
- The connector requires a paid Highspot license that supports API access.
- There is currently no direct API to list all users with access to a given Spot and user impersonation is used as a workaround.
- Due to API limitations, Glean cannot mirror Highspot’s native permissions. All Highspot documents indexed by Glean are visible to all Highspot users in Glean.
Crawling Strategy
| Crawl Type | Full Crawl | Incremental Crawl | People Data | Activity | Update Rate | Webhook | Notes |
|---|---|---|---|---|---|---|---|
| Spots & Items | Yes | No | No | No | 4 hours | No | Frequency depends on object type and impersonation used for permissions. |
| Users | Yes | No | Yes | No | 1 hour | No | Users fetched for permission mapping. |
Results Display
The results from Highspot will appear in Glean search with associated metadata such as title, author, date of publishing, and last modification date.Requirements
To use the Highspot connector, you must meet certain technical, credential, and permission requirements, as well as perform some preliminary setup in Highspot.Technical Requirements
- You must have a Highspot instance with API access enabled.
- Glean must be deployed in your environment with access to the Glean admin console.
- All data is stored in your GCP project and no data leaves your environment.
Credential Requirements
- API credentials like the client key and client secret are required. These are provided by Highspot after API access is enabled for your instance.
- A dedicated API user is created in Highspot for integration purposes.
Permission Requirements
- The API user’s access in Highspot determines what content is crawled and indexed.
- For full identity-based permissions support, you must enable
Impersonation in Highspot REST API.
Preliminary Source/System Setup
- Contact Highspot to enable API access for your organization.
- Obtain the necessary API credentials like the client key and secret.
- (Optional) Enable impersonation in the Highspot API for enriched permissions and identity crawling.
Configuration and Setup Instructions
This section guides you through configuring and setting up the Highspot connector in Glean. Most setup steps are performed in the Glean admin console.Prerequisites
- Highspot instance with API access enabled.
- API credentials (client key and secret) from Highspot.
- (Optional) Impersonation enabled in Highspot API for advanced permission support.
Step-by-Step Setup
Enabling API Functionality
Glean requires API functionality to search through Highspot’s content. Contact the Highspot support team to enable the API functionality for your instance and give the credentials to Glean.Determining the subdomain of your Highspot instance
You can determine the subdomain of your Highspot instance by checking the URL you use to access the instance. For example, if you access Highspot at acme.highspot.com, the subdomain is acme.Determining the Client Information
For Glean to access the API of your Highspot instance, provide the API URL, Client Key and Client Secret. To get the API URL, Client Key and Client Secret:- Log in to Highspot with your account credentials.
- Click your profile icon (usually located in the top right corner).
- Select Settings from the dropdown menu.
- Navigate to the Developer tab or section in the left-hand panel.
- Locate your API Key, Secret, and URL, which will be listed on this page.
Connecting Highspot connector and Glean
To validate the credentials and initiate the connection between the Highspot connector and Glean, perform the following steps:- In the Glean Admin console, navigate to Data sources.
- Click Add data source and add a new Highspot connector.
- Enter the required information:
- Highspot subdomain
- API URL for example: https://api-su2.highspot.com/v1.0
- API client key
- API client secret
- Click Save.
Crawl Configuration Options
- You can control which Spots or items are indexed by modifying the API user’s access in Highspot.
- There are no explicit red/greenlist or lookback period options and access is managed through the API user’s permissions.
- The connector supports both full and incremental crawls, with typical update rates between 1 and 4 hours depending on the object type.
Permissions & Security
Data and Metadata Ingested:- Spots, items, item metadata, and item content accessible to the API user.
Due to Highspot API limitations, when installed in its default configuration, all indexed Highspot content is visible to all Highspot users in Glean. An optional toggle enables spot-level permissions, which relies on user impersonation to fetch each user’s Spots and map content visibility to their spot membership. Enabling the spot-level permissions toggle requires a Highspot admin to authorize user impersonation. This toggle is off by default. Security & Compliance Notes:
- Authentication is handled through API credentials (client key and secret).
- All data remains within your GCP project and no data leaves your environment.
- The connector may impact your organization’s data privacy posture, as all indexed Highspot content becomes visible to all Highspot users in Glean, regardless of original Highspot permissions.