Connections
Connect external sources to GitBook Assistant and GitBook Agent
Connections let you bring external content into your docs site.
Connected content can appear in AI Search and GitBook Assistant. Some connections can also help GitBook generate change requests.
To add a connection, open your site’s Settings and click on Connections.
Available connections
How connections work
Connect a source
Select a source type. Then authorize it, or enter the URL you want GitBook to import.
If you connect YouTube, enter the channel ID — not the channel name.
A channel name won't work for this source.
In YouTube Studio, open Settings → Channel → Advanced settings.
Copy the Channel ID.
If your channel URL contains /channel/, copy the part after /channel/.
Each connection creates a stream of records from that source, such as issues, discussions, pages, or videos.
GitBook syncs records
After you save the connection, GitBook starts syncing records from that source.
In the connections list, you can review the sync status, record count, and last sync time.
Connected URLs refresh once a day by default. You can also trigger a refresh manually from your site’s Settings → Connections.
Connection settings
When you edit a connection, you can configure these options:
Label
Use Label to give the connection a clear name.
This makes the source easier to identify in the connections list, especially if you connect multiple repositories, websites, or channels.
Auto-generate change requests
Auto generating change requests is currently in early access.
See Automatic docs improvements for information on requesting access
Turn on Auto-generate change requests to let GitBook learn from the connection’s records and suggest documentation updates.
GitBook can use those records to create change requests with suggested changes for your team to review.
Expose in search / assistant
Turn on Expose in search / assistant to make records from this connection searchable by visitors and available to answer questions.
This allows connected content to appear in your site’s AI-powered search experience and in GitBook Assistant responses.
Enabling Expose in search / assistant makes records from that connection available to anyone who can access the site — including external visitors if the site is shared externally.
Search ranking boost
Use Search ranking boost to prioritize or deprioritize records from a connection in search.
Increase the value if this source should appear more often. Lower it if this source should have less weight than your primary docs.
Data retention and privacy
What does GitBook index?
GitBook indexes content from your connections and uses it across search, change requests, and other content-driven features. Each item we index from a connection is called a record. Examples of records are Intercom tickets, Confluence pages, website pages, and more.
We use records to suggest content changes and provide additional context to agents running across GitBook.
We retain records for as long as the source remains connected. If you remove the connection, we delete all stored records. We do not delete any content that was generated using those records as context, or remove the content of records from any stored AI conversation logs.
For example, you might connect Intercom and GitBook suggests a documentation change based on a closed Intercom support ticket. If you then remove the Intercom connection, all our Intercom specific stored data is deleted, but the change requests will remain.
More information about our connectors can be found on the specific page for each connector.
FAQ
What is your policy around PII?
Generally, GitBook only requests source fields that it can use as context (see connector pages for more specifics on each source).
When we ingest a record, we pass it through PII redaction processes. The first is an in-memory redaction of any emails, phone numbers, addresses, and other personal information.
We then pass the record through a 2nd PII step using a 3rd party LLM. This is a ZDR-compliant, no-store request that is not stored on the servers of our 3rd party and is not used in any training.
PII may exist on our servers for a few minutes whilst we do this pre-processing, but we only store the post-processed record.
Do you send data to any 3rd parties?
We use a 3rd party to redact PII after our initial, internal PII redaction is done.
We also use the redacted record content in 3rd party providers when creating change requests and responding to user questions.
For example, when writing content with GitBook Agent, the agent may include content from an external record as additional context.
Last updated
Was this helpful?