Integrations
Help Scout integration
Connect a Help Scout Docs site, check its knowledge base role, and manage publishing and connection errors.
Help Scout integration
Connect Help Scout so Pageloop can read your articles and prepare updates for review in the Inbox. Nothing reaches Help Scout until a person publishes.
Help Scout can hold the Knowledge base role only, not the Ticketing role. For an overview of help-center connections and integration roles, see Connect your knowledge base.
Before you begin
- Sign in to Pageloop as an Admin.
- Check that your Help Scout plan includes the Docs API.
- Copy your Help Scout Docs API key. In Help Scout, open your avatar → Your Profile → Security and Access → Docs API. The key appears only if the account owner has granted Docs: Create new, edit settings & Collections permission.
- Decide which Help Scout site to connect if your account has several. You can link one Help Scout site per Pageloop integration.
Connect and configure Help Scout
-
Open Integrations, or Settings → Integrations. Find the Help Scout card under Knowledge base on the Integrations page and select Connect.
-
In Connect Help Scout, paste
<your API key>into API Key and select Continue. Find your API Key opens Help Scout's Docs API documentation. -
If your account has one site, Pageloop selects it automatically and shows Configuring <site>…. If your account has several sites, choose one under Choose a Help Scout site and select Connect site.
-
Check for Help Scout connected, with the message “Your Help Scout knowledge base is now linked to Pageloop.” The card reads Connected. Check Integration roles at the bottom of the page to see whether Knowledge base names Help Scout.
Check the Knowledge base role
The Knowledge base role is “Where Pageloop reads your articles from and publishes updates to.” Connecting Help Scout assigns this role only when no service holds it. If another service, such as Pageloop Docs, already holds the role, Help Scout connects but is not synced until you change the assignment. The success message does not warn you about an existing assignment.
To switch to Help Scout:
- Under Integration roles, select Change on Knowledge base. If the role is Not set, select Choose instead.
- In Change Knowledge Base, select Help Scout. The dialog says “Pick a connected service to read from and write to.”
- Select Save and confirm that Knowledge base names Help Scout.
There are no settings on the Help Scout card after connecting, and the card has no gear button. To switch sites, disconnect Help Scout, then connect again and choose the other site.
What Pageloop reads and writes
When Help Scout holds the Knowledge base role, Pageloop reads the connected site's collections, categories, and articles, including published and unpublished articles. Pageloop syncs this content every hour.
Pageloop's proposals arrive in the Inbox for review. When you publish an article, choose where the article goes and select Publish or Save as draft in Help Scout. Connecting Help Scout and syncing articles do not publish proposals automatically.
If your Knowledge base settings show Default publish mode for Help Scout, choose Draft or Live to set whether published changes are saved as drafts or go live in Help Scout. Draft is the safer default.
In Draft mode, Help Scout saves only the article text as a draft. Title and category changes go live when you publish, even in Draft mode.
Disconnect
- In Integrations, point at Connected on the Help Scout card. The button changes to Disconnect. Select it.
- Review Disconnect Help Scout?, which says “Pageloop stops reading from and writing to it.” If Help Scout holds the Knowledge base role, the dialog warns that the role is left unassigned until you pick another integration.
- Select Disconnect to confirm, or Keep connected to cancel. Help Scout disconnected confirms the disconnection.
Disconnecting does not revoke anything in Help Scout. Delete the Docs API key in Help Scout if you no longer want Pageloop to have access.
Reconnect a paused or incomplete connection
If Pageloop loses access, for example because the key was deleted or syncing failed several times in a row, the card shows Needs reconnecting. The page says “Help Scout needs to be reconnected. Pageloop lost access, so it is paused until you reconnect it.” Closing setup before choosing a site also leaves the card showing Needs reconnecting.
Open the ... menu on the Help Scout card and select Disconnect. Then select Connect and complete setup again. Check the Knowledge base role after reconnecting.
Troubleshooting
The setup dialog shows connection errors. Publishing and sync messages appear when publishing or on the Knowledge base page, as noted below.
| Message or symptom | What to do |
|---|---|
| “Invalid Help Scout API key or insufficient permissions” | Check the key and confirm that the account owner granted Docs: Create new, edit settings & Collections permission. |
| “Could not reach Help Scout to validate the API key” | Try again shortly. |
| “No Help Scout sites are accessible with this API key.” | Check that the key belongs to the intended Help Scout account and that the account has an accessible Docs site. |
| “Help Scout is already connected. Disconnect the existing connection first if you want to reconnect.” | Open the card's ... menu, select Disconnect, then select Connect. |
| “Couldn’t connect <site>. Your API key is still saved — retry without re-entering it.” | Select Retry. You do not need to enter the key again. |
| “Chosen site does not belong to this Help Scout account.” | Check that the site you want belongs to the Help Scout account associated with the key. |
| Help Scout is Connected, but its articles are not synced. | Check the Knowledge base role. Another service may still hold it. |
| Needs reconnecting | Disconnect and connect again, including when setup was closed before a site was chosen. |
| “Help Scout refused this because the account's plan doesn't include the Docs API. Check the plan in Help Scout's billing settings.” (publishing) | Check the Help Scout plan in Help Scout's billing settings. The plan must include the Docs API. |
| “Pageloop can’t sign in to your Help Scout help center, so it isn’t syncing.” (Knowledge base) | Disconnect Help Scout, then connect again. |
| “Pageloop stopped syncing your Help Scout help center after it failed several times in a row.” (Knowledge base) | Disconnect Help Scout, then connect again. |
| “The last sync of your Help Scout help center didn’t finish. Pageloop keeps trying on its own.” (Knowledge base) | Pageloop retries automatically. |
| “Pageloop paused syncing: most of your Help Scout articles were missing from the last read, so it kept them rather than delete them. If you didn’t remove them, contact support.” (Knowledge base) | If you did not remove the articles, contact support. Pageloop kept the articles rather than deleting them. |

