Skip to main content

GitBook integration

  1. Go to Integrations. Click “Add” on the GitBook card.

    GitBook integration card

  2. Enter your (a) API key; (b) GitBook domain; (c) Space ID

    1. You can find your API key here.
    2. E.g., your-company.gitbook.io
    3. Login to GitBook and navigate to the Space you want to sync. Copy the Space ID from your browser URL, i.e.: https://app.gitbook.com/s/<your-space-id>

    GitBook integration inputs

  3. Optionally, adjust the settings. For more details on settings, read the section below.

  4. Click “Connect”. Your docs will start syncing. Once synced, you can click on the card to see the imported docs.

    GitBook import success

Automatic syncs

If on a Growth or Enterprise plan, you can set up your content to sync automatically — either daily or weekly.

GitBook integration settings​

  1. Sync frequency: The frequency of syncs. Note: automatic syncs are only available on Growth and Enterprise tiers.

    1. Manual — synced manually
    2. Weekly — automatically synced weekly
    3. Daily — automatically synced daily

  2. Default visibility: If set to "Live", your help docs will immediately be searchable in Spotlight.

    Integration settings