Overview
You do not need to provide a HelpScout URL or domain. The Docs API endpoint is the same for every HelpScout account, so the API key alone is enough to identify your workspace.
Note: This integration is for HelpScout Docs (knowledge base). For HelpScout ticketing integration, see HelpScout Ticketing Integration.
Prerequisites
- HelpScout account with Docs enabled
- An API key with read access to Docs (required — see below)
Step 1 — Get your API Key from HelpScout
- Log in to HelpScout
- Navigate to Your Profile > API Keys
- Click Generate API Key
- Copy the key (it won’t be shown again)
Step 2 — Enter the API Key in AGO
- In AGO, go to Knowledge > Sources
- Click Create New Source and select HelpScout
- Paste the API key into the API Key field
- (Optional) Configure the fields described below
- Save the source — without the API key, the import will fail
- Click Sync to start importing
Configuration
Required Fields
Optional Fields
What Gets Imported
For each HelpScout category visible to the API key (plus any extra IDs listed inadditional_categories_ids):
- A document representing the category itself
- One document per article in that category, attached to the category document as its parent
Article Structure
Each imported article is stored with:Sync Behavior
Every sync is a full re-import:- Articles and categories are fetched from HelpScout and either created or updated in AGO (matched by HelpScout ID)
- Any document from a previous sync that is no longer returned by HelpScout is deleted permanently from the knowledge source
- There is no incremental sync — modified-date filtering is not used
Troubleshooting
Authentication Error
Authentication Error
- Verify your API key is correct
- Check the key hasn’t been revoked
- Ensure the key has Docs read permissions
No Articles Imported
No Articles Imported
- Check the API key has access to at least one category in HelpScout Docs
- Confirm the categories you expect to import are visible to that API key
- Review sync history for specific errors
Missing Content
Missing Content
- Confirm the article is reachable in HelpScout under one of the categories returned by the Docs API
- If you expect a category that isn’t being picked up automatically, add its ID to
additional_categories_ids
Related Documentation
- Knowledge Connectors - All available connectors
- Knowledge Source Management - Source configuration
- HelpScout Ticketing Integration - Ticketing integration
