Skip to main content
Feature

Documentation where the question is being asked

A knowledge base nobody visits is not a knowledge base. Push it into the helpdesk, the chat channel and the product - and build the rest on the API.

  • Helpdesk agent assist
  • Slack and Teams search
  • REST API and webhooks

What does TheDocs integrate with?

TheDocs connects to helpdesks (Zendesk, Freshdesk, Intercom, HubSpot, Help Scout), chat (Slack, Microsoft Teams), issue trackers (Jira, Linear, GitHub Issues), source control and CI (GitHub, GitLab, Azure DevOps), identity providers (Okta, Entra ID, Google Workspace and any SAML or OIDC provider), and analytics (GA4, Segment, Plausible). Everything else is reachable through a REST API and signed webhooks.

  • Helpdesk: suggest articles to agents and insert them into replies.
  • Chat: search documentation from Slack or Teams with a slash command.
  • Issue trackers: turn a documentation gap into a ticket, and back again.
  • CI: publish Markdown or an OpenAPI spec from your pipeline.
  • Identity: SAML and OIDC providers, plus SCIM on Enterprise.
  • REST API with full article content, and signed webhooks with replay.
Integrations

Where TheDocs shows up

The ones that matter most are usually the helpdesk and the chat tool.

In your helpdesk

Zendesk, Freshdesk, Intercom, HubSpot and Help Scout. Agents see suggested articles beside the ticket and insert one into a reply in a click.

In Slack and Teams

A slash command returns the grounded answer with sources, honouring the asker's permissions. Unanswered questions still land in your gap report.

In Jira and Linear

Create an issue from a content gap, and link an article to the ticket that prompted it so the next release knows what to update.

In your repository and CI

Publish Markdown from a repo, push an OpenAPI spec on release, and open a documentation task automatically when a labelled PR merges.

In your analytics

GA4, Segment and Plausible tags alongside the built-in reporting, so documentation behaviour joins the rest of your funnel.

Anywhere else

REST API and signed webhooks. Whatever we have not built, you can - and the API returns full article content, not just metadata.

In detail

Building on TheDocs

A REST API that returns the actual content

Plenty of documentation APIs hand you IDs and titles and stop there. That is not enough to build anything real.

  • Articles with full body content in Markdown, HTML or structured blocks.
  • Categories, versions, languages, media, users and permissions.
  • Search and AI answer endpoints, so you can put grounded answers into your own product.
  • Cursor pagination, ETags and conditional requests for efficient syncing.
  • Scoped API keys - a CI key that can publish but not read private projects.
  • Published rate limits, and headers telling you where you stand against them.

Webhooks you can trust

An event system without delivery guarantees creates a class of bug nobody enjoys debugging.

  • Events for publish, update, unpublish, approval, comment and feedback.
  • HMAC-signed payloads so you can verify the sender.
  • Automatic retry with exponential backoff for up to 24 hours.
  • A delivery log with request, response and status, and manual replay for anything that failed.
  • Per-endpoint event filtering so a consumer only receives what it cares about.

The most common use is refreshing an in-product help cache when an article publishes, which keeps embedded help current without polling.

Frequently asked

Questions people ask before they start

Zendesk, Freshdesk, Intercom, HubSpot Service Hub and Help Scout natively, with agent-side article suggestions and the ability to insert an article into a reply. Anything else can be built on the API.

Yes. A slash command returns the AI answer with its sources, respecting the asker's permissions. It is usually the integration with the highest adoption because it meets people where the question is already being asked.

Yes - a REST API covering articles, categories, media, versions, users, permissions and search, with full article content rather than metadata only. Rate limits are published, and the API is available from the Business plan.

Yes. Subscribe to publish, update, unpublish, approval and comment events, delivered with a signed payload, automatic retries and a delivery log you can inspect and replay.

Yes. Push Markdown files or an OpenAPI specification from your pipeline with a scoped API key, so a release can ship its documentation as part of the same job.

Put documentation search in the channel your team already uses.

Start free for 14 days. No credit card, no setup fee, and your content is yours to export at any time.

Questions first? Email sales@thedocs.in or call +91 8585953085.