GitBook
Use this page to set up the GitBook source connector and review its reference information.
The GitBook source connector uses the GitBook API to sync data from GitBook. It syncs your user profile, your organizations and their members. It also syncs the published page tree for one GitBook space.
Prerequisites
- A GitBook account with access to the space you want to sync.
- A GitBook personal access token. This token has the same access and privileges as the GitBook account that created it. The connector can only read organizations, members and spaces visible to this user.
- The ID of the GitBook space you want to sync.
Setup
Step 1: Create an access token
- Sign in to GitBook and open your user account’s Developer settings.
- Create and copy a personal access token. For details, see Authentication in the GitBook documentation.
Step 2: Find your space ID
Open the space in the GitBook app, then check the URL in your browser. The URL follows the pattern https://app.gitbook.com/o/<organization_id>/s/<space_id>. Your space ID is the value after /s/. For details, see Find your IDs in the GitBook documentation.
Step 3: Set up the Airbyte connector
- In Airbyte, go to Sources and select GitBook.
- For Access Token, enter the personal access token from Step 1.
- For Space Id, enter the space ID from Step 2.
- Select Set up source.
Configuration
| Input | Type | Description | Default Value |
|---|---|---|---|
access_token | string | Access Token. Personal access token for authenticating with the GitBook API. You can view and manage your access tokens in the Developer settings of your GitBook user account. | |
space_id | string | Space Id. |
Supported sync modes
You can use the following sync modes with the GitBook source connector:
The connector doesn’t support incremental syncs.
Supported streams
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
|---|---|---|---|---|
| users | DefaultPaginator | ✅ | ❌ | |
| organizations | id | DefaultPaginator | ✅ | ❌ |
| content | id | DefaultPaginator | ✅ | ❌ |
| org_members | id | DefaultPaginator | ✅ | ❌ |
users: The profile of the GitBook user who owns the access token, fromGET /v1/user. This stream returns one record and has no primary key.organizations: The organizations that the authenticated user belongs to.content: The pages in the configured space’s current published revision. Each record represents a top-level page. Child pages are nested in the record’spagesfield. Unpublished edits, including open change requests, aren’t included.org_members: The members of each organization returned by theorganizationsstream.
Limitations
- Each source syncs content from one space. To sync several spaces, create a separate source for each space.
- The GitBook API enforces rate limits. It returns HTTP
429responses when you exceed them. For details, see Rate limiting in the GitBook documentation.
Breaking changes
Upgrade to 0.1.0
GitBook removed the GET /v1/spaces/{spaceId}/insights/traffic endpoint from its API, so the insights_traffic stream was removed. If your connection has insights_traffic selected, deselect it before syncing again. See the GitBook migration guide for details.
IP allow list
If you use Airbyte Cloud and restrict access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.1.5 | 2026-11-10 | 91490 | Update dependencies |
| 0.1.4 | 2026-11-03 | 90540 | Update dependencies |
| 0.1.3 | 2026-10-27 | 89907 | Update dependencies |
| 0.1.2 | 2026-10-20 | 89232 | Update dependencies |
| 0.1.1 | 2026-10-13 | 88625 | Update dependencies |
| 0.1.0 | 2026-10-09 | 88268 | Breaking: remove the insights_traffic stream; GitBook removed the GET /v1/spaces/{spaceId}/insights/traffic endpoint. See the migration guide. |
| 0.0.64 | 2026-10-06 | 87825 | Update dependencies |
| 0.0.63 | 2026-09-29 | 87183 | Update dependencies |
| 0.0.62 | 2026-09-22 | 86624 | Update dependencies |
| 0.0.61 | 2026-09-15 | 86059 | Update dependencies |
| 0.0.60 | 2026-09-08 | 85459 | Update dependencies |
| 0.0.59 | 2026-08-18 | 84593 | Update dependencies |
| 0.0.58 | 2026-08-11 | 83949 | Update dependencies |
| 0.0.57 | 2026-08-04 | 83465 | Update dependencies |
| 0.0.56 | 2026-07-28 | 82921 | Update dependencies |
| 0.0.55 | 2026-07-21 | 82430 | Update dependencies |
| 0.0.54 | 2026-07-14 | 81836 | Update dependencies |
| 0.0.53 | 2026-06-30 | 81082 | Update dependencies |
| 0.0.52 | 2026-06-23 | 80479 | Update dependencies |
| 0.0.51 | 2026-06-16 | 79875 | Update dependencies |
| 0.0.50 | 2026-06-09 | 79332 | Update dependencies |
| 0.0.49 | 2026-06-02 | 78734 | Update dependencies |
| 0.0.48 | 2026-04-28 | 77237 | Update dependencies |
| 0.0.47 | 2026-04-21 | 76605 | Update dependencies |
| 0.0.46 | 2026-03-17 | 74564 | Update dependencies |
| 0.0.45 | 2026-03-03 | 74195 | Update dependencies |
| 0.0.44 | 2026-02-10 | 73081 | Update dependencies |
| 0.0.43 | 2026-01-20 | 71964 | Update dependencies |
| 0.0.42 | 2026-01-14 | 71381 | Update dependencies |
| 0.0.41 | 2025-12-18 | 70697 | Update dependencies |
| 0.0.40 | 2025-11-25 | 69872 | Update dependencies |
| 0.0.39 | 2025-11-18 | 69379 | Update dependencies |
| 0.0.38 | 2025-10-29 | 69046 | Update dependencies |
| 0.0.37 | 2025-10-21 | 68328 | Update dependencies |
| 0.0.36 | 2025-10-14 | 68002 | Update dependencies |
| 0.0.35 | 2025-10-07 | 67261 | Update dependencies |
| 0.0.34 | 2025-09-30 | 66298 | Update dependencies |
| 0.0.33 | 2025-09-09 | 66061 | Update dependencies |
| 0.0.32 | 2025-08-23 | 65348 | Update dependencies |
| 0.0.31 | 2025-08-09 | 64619 | Update dependencies |
| 0.0.30 | 2025-08-02 | 64204 | Update dependencies |
| 0.0.29 | 2025-07-26 | 63902 | Update dependencies |
| 0.0.28 | 2025-07-19 | 63478 | Update dependencies |
| 0.0.27 | 2025-07-12 | 63133 | Update dependencies |
| 0.0.26 | 2025-07-05 | 62614 | Update dependencies |
| 0.0.25 | 2025-06-28 | 62173 | Update dependencies |
| 0.0.24 | 2025-06-21 | 61820 | Update dependencies |
| 0.0.23 | 2025-06-14 | 61079 | Update dependencies |
| 0.0.22 | 2025-05-24 | 60366 | Update dependencies |
| 0.0.21 | 2025-05-10 | 60039 | Update dependencies |
| 0.0.20 | 2025-05-03 | 58840 | Update dependencies |
| 0.0.19 | 2025-04-19 | 58351 | Update dependencies |
| 0.0.18 | 2025-04-12 | 57825 | Update dependencies |
| 0.0.17 | 2025-04-05 | 57195 | Update dependencies |
| 0.0.16 | 2025-03-29 | 55996 | Update dependencies |
| 0.0.15 | 2025-03-08 | 55329 | Update dependencies |
| 0.0.14 | 2025-03-01 | 54993 | Update dependencies |
| 0.0.13 | 2025-02-22 | 54383 | Update dependencies |
| 0.0.12 | 2025-02-15 | 53739 | Update dependencies |
| 0.0.11 | 2025-02-08 | 53344 | Update dependencies |
| 0.0.10 | 2025-02-01 | 52856 | Update dependencies |
| 0.0.9 | 2025-01-25 | 52358 | Update dependencies |
| 0.0.8 | 2025-01-18 | 51632 | Update dependencies |
| 0.0.7 | 2025-01-11 | 51061 | Update dependencies |
| 0.0.6 | 2024-12-28 | 50563 | Update dependencies |
| 0.0.5 | 2024-12-21 | 50002 | Update dependencies |
| 0.0.4 | 2024-12-14 | 49517 | Update dependencies |
| 0.0.3 | 2024-12-12 | 49166 | Update dependencies |
| 0.0.2 | 2024-12-11 | 48910 | Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64 |
| 0.0.1 | 2024-10-30 | Initial release by @bishalbera via Connector Builder |