Authorization Type

Gitbook uses API token authentication to connect to Gitbook.

Then you’ll need to POST the credentials to /integrations/gitbook.

Authorization Flow


Enter your API access token and organization name (visible on top left).

Where can I find my API key?

  1. Log in to your Gitbook account.

  2. Click on “Settings” in the bottom left corner of your account.

  1. Click on “Account Settings” from the drop-down menu.

  1. Click on “Developer Settings” from the “Settings” menu.

  1. Click “Create new token” to generate a new access token.

  1. Copy the API token that is generated.


You can choose which Gitbook spaces to sync with Carbon.

You can list all spaces with /integrations/gitbook/spaces and sync multiple spaces at once with integrations/gitbook/sync.

Specific pages can be listed and synced with the global endpoints /integrations/items/list and /integrations/files/sync respectively.


Syncs are triggered when end-users select specific pages. You can use the resync_file API endpoint to programmatically resync specific Gitbook pages.

To sync Gitbook files on a 24-hour schedule (more frequent schedules available upon request), you can use the /update_users endpoint. This endpoint allows organizations to customize syncing settings according to their requirements, with the option to enable syncing for all data sources using the string ‘ALL’. It’s important to note that each request supports up to 100 customer IDs.

Here’s an example illustrating how to automatically enable syncing for updated Gitbook content for specified users:

    "customer_ids": ["", ""],
    "auto_sync_enabled_sources": ["GITBOOK"]