| Specification | Details |
|---|---|
| Repository type | Cloud |
| Supported content | Articles |
| RACL support | Yes |
| Content filtering | No |
| Auto permission resolution | Yes |
Prerequisites
Search AI uses two HelpScout APIs:- Docs API — fetches article content and metadata; authenticated via API Key
- Inbox API — fetches access and user details; authenticated via OAuth 2.0
Generate an API Key
- Click the person icon in the top-right of your HelpScout account.
- Select Your Profile.
- In the left menu, click Authentication, then select the API Keys tab.
- Generate and copy the API key.
Note: You need “Docs: Create new, edit settings & Collections” permission to generate an API key.
Create OAuth Client Credentials
- Go to your Profile > My Apps and click Create My App.
- Enter the Redirection URL for your region:
| Region | Callback URL |
|---|---|
| JP | https://jp-bots-idp.kore.ai/workflows/callback |
| DE | https://de-bots-idp.kore.ai/workflows/callback |
| Production | https://idp.kore.com/workflows/callback |
- Click Save. Note the generated App ID and App Secret.
Configure the HelpScout Connector
- Navigate to Content > Connectors in Search AI and select HelpScout.
- On the Authorization tab, enter the following details:
| Field | Description |
|---|---|
| Name | Unique name for the connector |
| API Key | API Key generated above |
| Client ID | App ID from the OAuth client app |
| Client Secret | App Secret from the OAuth client app |
- Click Connect.
Content Ingestion
The connector ingests published articles from all collections in your HelpScout account. For each article, Search AI captures:- Article content in text and HTML format
- Metadata: category, collection, URL, creation date, and update date
RACL Support
Search AI controls access to HelpScout content based on the visibility of article collections.- Articles in a public collection have
sys_raclset to*, making them visible to all users. - Articles in a private collection have
sys_raclset to the collection ID, which acts as a permission entity.