Advanced Analytica Advanced Analytica: IBOM
← All connectors
GitBook logo

Source connector

GitBook

Set up GitBook as a source and move its data into your chosen destination.

Version 0.1.5 community alpha

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

  1. Sign in to GitBook and open your user account’s Developer settings.
  2. 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

  1. In Airbyte, go to Sources and select GitBook.
  2. For Access Token, enter the personal access token from Step 1.
  3. For Space Id, enter the space ID from Step 2.
  4. Select Set up source.

Configuration

InputTypeDescriptionDefault Value
access_tokenstringAccess 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_idstringSpace 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 NamePrimary KeyPaginationSupports Full SyncSupports Incremental
usersDefaultPaginator✅❌
organizationsidDefaultPaginator✅❌
contentidDefaultPaginator✅❌
org_membersidDefaultPaginator✅❌
  • users: The profile of the GitBook user who owns the access token, from GET /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’s pages field. Unpublished edits, including open change requests, aren’t included.
  • org_members: The members of each organization returned by the organizations stream.

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 429 responses 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
VersionDatePull RequestSubject
0.1.52026-11-1091490Update dependencies
0.1.42026-11-0390540Update dependencies
0.1.32026-10-2789907Update dependencies
0.1.22026-10-2089232Update dependencies
0.1.12026-10-1388625Update dependencies
0.1.02026-10-0988268Breaking: remove the insights_traffic stream; GitBook removed the GET /v1/spaces/{spaceId}/insights/traffic endpoint. See the migration guide.
0.0.642026-10-0687825Update dependencies
0.0.632026-09-2987183Update dependencies
0.0.622026-09-2286624Update dependencies
0.0.612026-09-1586059Update dependencies
0.0.602026-09-0885459Update dependencies
0.0.592026-08-1884593Update dependencies
0.0.582026-08-1183949Update dependencies
0.0.572026-08-0483465Update dependencies
0.0.562026-07-2882921Update dependencies
0.0.552026-07-2182430Update dependencies
0.0.542026-07-1481836Update dependencies
0.0.532026-06-3081082Update dependencies
0.0.522026-06-2380479Update dependencies
0.0.512026-06-1679875Update dependencies
0.0.502026-06-0979332Update dependencies
0.0.492026-06-0278734Update dependencies
0.0.482026-04-2877237Update dependencies
0.0.472026-04-2176605Update dependencies
0.0.462026-03-1774564Update dependencies
0.0.452026-03-0374195Update dependencies
0.0.442026-02-1073081Update dependencies
0.0.432026-01-2071964Update dependencies
0.0.422026-01-1471381Update dependencies
0.0.412025-12-1870697Update dependencies
0.0.402025-11-2569872Update dependencies
0.0.392025-11-1869379Update dependencies
0.0.382025-10-2969046Update dependencies
0.0.372025-10-2168328Update dependencies
0.0.362025-10-1468002Update dependencies
0.0.352025-10-0767261Update dependencies
0.0.342025-09-3066298Update dependencies
0.0.332025-09-0966061Update dependencies
0.0.322025-08-2365348Update dependencies
0.0.312025-08-0964619Update dependencies
0.0.302025-08-0264204Update dependencies
0.0.292025-07-2663902Update dependencies
0.0.282025-07-1963478Update dependencies
0.0.272025-07-1263133Update dependencies
0.0.262025-07-0562614Update dependencies
0.0.252025-06-2862173Update dependencies
0.0.242025-06-2161820Update dependencies
0.0.232025-06-1461079Update dependencies
0.0.222025-05-2460366Update dependencies
0.0.212025-05-1060039Update dependencies
0.0.202025-05-0358840Update dependencies
0.0.192025-04-1958351Update dependencies
0.0.182025-04-1257825Update dependencies
0.0.172025-04-0557195Update dependencies
0.0.162025-03-2955996Update dependencies
0.0.152025-03-0855329Update dependencies
0.0.142025-03-0154993Update dependencies
0.0.132025-02-2254383Update dependencies
0.0.122025-02-1553739Update dependencies
0.0.112025-02-0853344Update dependencies
0.0.102025-02-0152856Update dependencies
0.0.92025-01-2552358Update dependencies
0.0.82025-01-1851632Update dependencies
0.0.72025-01-1151061Update dependencies
0.0.62024-12-2850563Update dependencies
0.0.52024-12-2150002Update dependencies
0.0.42024-12-1449517Update dependencies
0.0.32024-12-1249166Update dependencies
0.0.22024-12-1148910Starting 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.12024-10-30Initial release by @bishalbera via Connector Builder
Advanced Analytica

Most businesses are sitting on information they can’t use at speed. The people who hold it are busy, and when they leave, the knowledge goes with them. The documents are static, and the processes around them weren’t designed for AI.

Advanced Analytica works with these businesses to turn that information into structured data assets. Once they're integrated, AI systems can govern it, and the business can use it. We bring in the strategy, the specification and the AI skills to rework how the business operates.

MOVE FAST. STAY SAFE.