Aha! setup
This page describes how to install and configure the Aha! connector. Setup takes place in both Aha! and the Glean admin console.
To set up the Aha! connector:
- Confirm the requirements.
- Determine your Aha! instance name.
- Generate an Aha! API key.
- Optionally, configure activity webhooks.
- Add the connector in Glean.
Requirements
The Aha! connector is designed for Aha! cloud deployments and relies on the Aha! REST API and webhooks. Confirm the following before you begin so that content retrieval and permission mapping work correctly.
Technical requirements
- An active Aha! cloud instance, for example
yourdomain.aha.io. - Your instance subdomain, which is the hostname before
.aha.io, and confirmation that your organization's Aha! plan includes REST API access. If you plan to use activity webhooks, confirm that your plan supports webhooks for your edition. - An Aha! user account with at least Viewer roles in all workspaces relevant for crawling.
- Network access to the Aha! REST API endpoints.
- A supported integration platform version within Glean.
Credential requirements
- An Aha! API key (personal access token) tied to a user account with the required permissions.
- The API key is generated in the Aha! web interface and entered during Glean connector setup. Store it securely.
- For webhook functionality, Glean recommends an Aha! user with Administrator and customization privileges, though these privileges are not strictly required for basic content indexing. For more information, see Enable the integration in the Aha! documentation.
Permission requirements
- Crawling and indexing require at minimum a Viewer role for all relevant workspaces or workspace lines.
- Administrator rights are needed to set up activity webhooks covering all workspaces.
- Only users with a Viewer or higher role have their associated content indexed and made accessible in Glean.
- Permission propagation relies on the Aha! workspace (product) and product line hierarchy. Users may inherit access to descendant workspaces.
Step 1: Determine your Aha! instance name
Identify your instance name from your organization's Aha! URL. For example, if your URL is https://glean.aha.io/, your instance name is glean. You provide this value in the Glean admin console in step 4.
Step 2: Generate an Aha! API key
Glean uses personal API keys to authenticate with your Aha! instance.
- Generate an API key in the Aha! user interface.
- Copy the generated API token. You provide this value in the Glean admin console in step 4.
Step 3: Configure activity webhooks (optional)
Activity webhooks allow Glean to capture updates in Aha! shortly after they happen.
Creating an activity webhook integration requires elevated administrative permissions in Aha!. Verify your access level before continuing.
-
Follow the Aha! documentation to enable the activity webhook integration.
-
Copy the unique webhook URL generated for you in the Glean setup screen. It follows this format:
https://<your-domain>.glean.com/instance/AHA/events -
Paste this value into the Hook URL field during the webhook configuration step in Aha!.
Step 4: Add the connector in Glean
- In the Glean admin console, go to Connectors and select Add connector.
- Select Aha!.
- Enter a name for the connector.
- Paste the API key from step 2 into the API token field.
- Paste the instance name from step 1 into the Aha instance name field.
- Select Save.
What happens next
Glean begins an initial crawl and indexes all accessible ideas and features according to the permissions of the API key holder. Subsequent crawls fetch only content that changed. If you configured activity webhooks, webhook events keep the index up to date as content changes in Aha!.
Aha! API rate limits apply during crawls: up to 300 requests per minute and up to 20 requests per second per source IP address.