--- title: Help Scout Docs API Integration on Truto slug: helpscoutdocs category: Helpdesk canonical: "https://truto.one/integrations/detail/helpscoutdocs/" --- # Help Scout Docs API Integration on Truto **Category:** Helpdesk **Status:** Generally available ## Unified APIs ### Unified Knowledge Base API - **Collections** — - **Files** — - **Page-Content** — Represents the content of a page - **Pages** — Represents the pages, posts, articles in a knowledge base - **Spaces** — Represents the high level grouping of pages in a knowledge base ## How it works 1. **Link your customer's Help Scout Docs account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Help Scout Docs.** The Proxy API is a 1-to-1 mapping of the Help Scout Docs API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Power AI support agents with Help Scout Docs content** — AI customer service platforms can ingest their customers' Help Scout Docs articles to build RAG-powered knowledge retrieval. This lets them auto-draft accurate responses to support tickets with citations linking back to the original help articles. - **Build federated search across knowledge bases** — Enterprise search and knowledge management tools can index Help Scout Docs alongside other sources like Confluence and Notion, giving employees a single search bar that spans all company knowledge. Truto's Unified Knowledge Base API normalizes the data model across all these platforms. - **Sync release notes and product updates to Help Scout Docs** — Product management and changelog tools can offer a one-click publish feature that automatically creates or updates articles in a customer's Help Scout Docs collection, eliminating the manual copy-paste workflow between tools. - **Surface contextual help articles inside your product** — Digital adoption and in-app guidance platforms can pull relevant Help Scout Docs articles into their own UI based on the screen a user is viewing, giving end users self-service answers without leaving the product. - **Automate knowledge base migration and backup** — Data migration and backup SaaS products can offer seamless import/export of Help Scout Docs content, preserving the full hierarchy of sites, collections, articles, and embedded files when customers switch helpdesk platforms. ## What you can build - **One-click Help Scout Docs ingestion pipeline** — Let your users connect their Help Scout account and automatically pull every Space, Collection, Page, and File into your system for AI training, search indexing, or content analysis. - **Structured knowledge base browser** — Render a customer's full Help Scout Docs hierarchy — Spaces, Collections, and Pages — inside your own UI so support agents or end users can browse help content without switching tabs. - **Automated article publisher** — Programmatically create and update Pages and Page-Content in a customer's Help Scout Docs from your product, enabling workflows like changelog syndication, auto-generated FAQs, or translated article publishing. - **Incremental content sync with delta detection** — Monitor page update timestamps to keep external search indexes, vector databases, or content mirrors perfectly in sync with the latest Help Scout Docs edits without re-ingesting everything. - **Embedded file and asset extraction** — Pull images, PDFs, and other files attached to Help Scout Docs articles so your platform can process, rehost, or include them in AI context alongside the article text. - **Cross-platform knowledge base unification** — Use Truto's Unified Knowledge Base API to normalize Help Scout Docs content alongside Zendesk Guide, Intercom Articles, and other helpdesk KBs into a single consistent data model your product can query uniformly. ## FAQs ### What data models does Truto's Unified Knowledge Base API support for Help Scout Docs? The Unified Knowledge Base API maps Help Scout Docs into five standardized models: Spaces (Help Scout Sites), Collections (Help Scout Collections and Categories), Pages (Articles), Page-Content (the rich text body of articles), and Files (embedded images, PDFs, and other assets). ### Are there specific Truto tools available for Help Scout Docs? Help Scout Docs does not have pre-built Truto tools at this time. Custom tools are built on request based on your integration requirements. The Unified Knowledge Base API resources (Spaces, Collections, Pages, Page-Content, Files) are available for standardized read and write operations. ### How does authentication work for Help Scout Docs integrations through Truto? Truto handles the OAuth 2.0 flow for Help Scout on behalf of your end users. Your application never touches raw credentials — Truto manages token storage, refresh, and renewal so your users can connect their Help Scout account with a single authorization step. ### Can I write data back to Help Scout Docs, or is it read-only? The Unified Knowledge Base API supports both read and write operations. You can create new Pages and Page-Content programmatically, enabling use cases like automated article publishing, content syndication, and localized article creation. ### How can I keep my data in sync with Help Scout Docs without full re-ingestion? You can implement delta syncs by monitoring the updated_at timestamps on Pages. By comparing these timestamps against your last sync, you only pull content that has changed since your previous fetch, keeping search indexes and AI embeddings current without unnecessary API calls. ### Does Truto handle pagination and rate limits for the Help Scout Docs API? Yes. Truto abstracts away Help Scout's API-specific pagination logic and rate limiting. Your application uses Truto's standardized pagination interface, and Truto manages retries and throttling behind the scenes so you don't have to build that plumbing yourself.