HelpScout Docs

Overview

A HelpScout docs source allows Inkeep to ingest content from your HelpScout docs collections.

Setup Requirements

API Key

When creating a HelpScout docs source, you will need an API key to authenticate Inkeep's access to your HelpScout docs.

Getting Your API Key: For detailed instructions on obtaining your HelpScout docs API key, please refer to the official HelpScout documentation.

Configuration Parameters

Collection IDs

Collection IDs specify which HelpScout docs collections you want Inkeep to ingest. You can specify one or multiple collection IDs to control which documentation gets indexed.

Finding Collection IDs:

1. Navigate to your HelpScout docs
2. Open the collection you want to include
3. Look at the URL in your browser: https://secure.helpscout.net/docs/{collectionId}
4. Copy the collection ID from the URL

Behavior:

• With Collection IDs specified: Only articles from the specified collections will be ingested
• No Collection IDs: All collections will be included in the ingestion