Linking GitBook as a source
Let AI connect your sources for you
Skip the manual setup — run this in your project and the wizard auto-detects your databases and APIs and connects them to PostHog.
This source is currently in alpha. The interface and available tables may change.
The GitBook connector syncs organizations, spaces, collections, and more into the PostHog data warehouse, so you can analyze them alongside your product data.
Prerequisites
Credentials that can read the data you want to sync. PostHog only reads data, so read access is enough.
Adding a data source
- In PostHog, go to the Sources tab of the data pipeline section.
- Click + New source and click Link next to this source.
- Enter your credentials (see Configuration below) and click Next.
- Select the tables you want to sync, choose a sync method and frequency, then click Import.
Once the syncs are complete, you can start querying this data in PostHog.
Enter your GitBook API token to pull your documentation workspace.
You can create a personal access token under Account settings → Developer in GitBook. The token inherits your account permissions and grants read access to your organizations, spaces, collections, sites, members, teams, change requests, and comments.
You'll be asked for:
- API token
Sync modes
Each table can be synced in one of several modes, depending on what the source supports:
- Webhook (when available) – the source pushes changes to PostHog in real time. Fastest freshness, lowest ongoing cost, and the only mode that reliably captures updates and deletes.
- Incremental – only new or updated rows are synced on each run, using a cursor field (such as an
updated_attimestamp). Cheaper than a full refresh, but deletes aren't captured. - Append only – new rows are appended using a cursor field; existing rows are never updated. Ideal for immutable, append-only tables like event logs.
- Full refresh – the whole table is reloaded on every sync. Use it when a table has no reliable cursor or when you need deletions reflected.
See sync methods for a full explanation of how each mode works and how to choose between them.
All GitBook tables are full refresh. Each sync replaces the contents of the table.
Configuration
| Option | Type | Required |
|---|---|---|
API token | password | Yes |
Supported tables
| Table | Description | Sync method | Incremental field | Primary key |
|---|---|---|---|---|
organizations | Organizations the API token's owner is a member of. An organization is the top-level workspace that owns spaces, collections, sites, and members. | Full refresh | — | — |
spaces | Spaces across every organization the token can access. A space is a single project of documentation content. | Full refresh | — | — |
collections | Collections across every organization the token can access. A collection groups spaces (and nested collections) together. | Full refresh | — | — |
sites | Published documentation sites across every organization the token can access. | Full refresh | — | — |
members | Organization memberships across every organization the token can access. One row per user per organization. | Full refresh | — | — |
teams | Teams across every organization the token can access. Teams group organization members for access management. | Full refresh | — | — |
change_requests | Change requests across every organization the token can access. A change request is a proposed set of edits to a space's content, similar to a pull request. | Full refresh | — | — |
comments | Comments posted on spaces across every organization the token can access. | Full refresh | — | — |
pages | Pages in the current revision of every space the token can access, flattened from the space's page tree to one row per page. | Full refresh | — | — |
site_questions | Unique questions visitors asked the Ask AI assistant on each docs site, with usage stats. | Full refresh | — | — |
site_answers | Individual answers the Ask AI assistant generated on each docs site, with the raw question, channel, and feedback. | Incremental, Full refresh | createdAt | — |
team_members | Membership of every team in every organization the token can access, with each member's role in the team. | Full refresh | — | — |
Troubleshooting
- If the connection fails with an authorization error, the API token is wrong, expired, or has been revoked. Create a new one, then reconnect the source.
- If a table syncs no rows, the credential may not have access to that data. Check its permissions, then reconnect the source.
If your sync is failing or data looks wrong, see the Data warehouse troubleshooting guide. If that doesn't help, contact support – we're happy to help.