> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/gitbook-agent/channels.md).

# Channels

Use AI Assistant and GitBook Agent in Slack, GitHub, Linear, and Jira

{% hint style="warning" %}

#### Channels are in early access

We’re slowly rolling out access to channels. Stay tuned for more progress on the features below.
{% endhint %}

Channels bring [AI Assistant](/docs/ai-for-your-readers/gitbook-ai-assistant.md) and [GitBook Agent](/docs/gitbook-agent/overview.md) into the tools your team already uses. Once connected, your team can mention `@GitBook` in Slack, GitHub, or Linear to ask questions, open change requests, and keep your docs up to date — without leaving their existing workflow.

When you add a channel, you choose how GitBook shows up in that tool. Each configuration runs in one of two modes:

**Support agent:** AI Assistant answers questions from your team or visitors directly in the channel. Ask a question, get an answer pulled from your docs. In Slack, citations in these replies link to the published site URL for the docs they reference. For example, a cited answer links to your docs site, not `app.gitbook.com`.

**Collaborator:** GitBook Agent joins as a teammate. Mention `@GitBook` to open change requests, request edits, or keep your docs in sync with what’s happening in that tool. In Slack, messages can link to `app.gitbook.com` when they reference internal workflow context, such as a change request or draft content. When GitBook Agent creates a change request from a channel, it automatically links it to the originating thread, issue, or pull request.

You can run multiple configurations per channel — for example, Support Agent mode for one customer-facing Slack channel, and Collaborator mode in another channel for your docs team.

To add a channel, open your site’s **Settings** and click **Channels**.

Use Channels when support questions, bug reports, or product feedback start in Slack, GitHub, Linear, or Jira and you want GitBook to respond in place.

{% hint style="info" %}

#### Looking to embed AI Assistant in your website or product?

Head to [Embed in your product](/docs/publish/embedding.md) to learn how to embed AI Assistant.
{% endhint %}

<figure><img src="https://1050631731-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2FvdGn4ibGuysRhvoOiAkI%2F26_05_01_channels%402x.png?alt=media&amp;token=e6cececa-7769-4e66-8f27-2995a822c946" alt=""><figcaption></figcaption></figure>

### Available channels

<table data-view="cards"><thead><tr><th></th><th><select><option value="mjZVekTsgGQo" label="In progress" color="blue"></option><option value="exlMMXLVjkth" label="Planned" color="blue"></option><option value="WK4vEyJjJM8h" label="Available" color="blue"></option></select></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Slack</strong></td><td><span data-option="WK4vEyJjJM8h">Available</span></td><td></td><td></td></tr><tr><td><strong>Linear</strong></td><td><span data-option="WK4vEyJjJM8h">Available</span></td><td></td><td></td></tr><tr><td><strong>GitHub</strong></td><td><span data-option="WK4vEyJjJM8h">Available</span></td><td></td><td></td></tr><tr><td><strong>Jira</strong></td><td><span data-option="WK4vEyJjJM8h">Available</span></td><td></td><td></td></tr></tbody></table>

### Coming soon

<table data-view="cards"><thead><tr><th></th><th><select><option value="mjZVekTsgGQo" label="In progress" color="blue"></option><option value="exlMMXLVjkth" label="Planned" color="blue"></option><option value="WK4vEyJjJM8h" label="Available" color="blue"></option></select></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Discord</strong></td><td><span data-option="exlMMXLVjkth">Planned</span></td><td></td><td></td></tr><tr><td><strong>Intercom</strong></td><td><span data-option="exlMMXLVjkth">Planned</span></td><td></td><td></td></tr><tr><td><strong>Microsoft Teams</strong></td><td><span data-option="exlMMXLVjkth">Planned</span></td><td></td><td></td></tr><tr><td><strong>Google Chat</strong></td><td><span data-option="exlMMXLVjkth">Planned</span></td><td></td><td></td></tr><tr><td><strong>Request a channel</strong></td><td></td><td><i class="fa-arrow-up-right-from-square">:arrow-up-right-from-square:</i></td><td><a href="https://github.com/orgs/GitbookIO/discussions/new?category=feature-requests">https://github.com/orgs/GitbookIO/discussions/new?category=feature-requests</a></td></tr></tbody></table>

### Overview

Channels connect GitBook to external workflows.

They let you:

* Answer questions without leaving the source conversation.
* Bring existing docs context into support and product workflows.
* Turn important conversations into docs updates with [GitBook Agent](/docs/gitbook-agent/overview.md).

Use Channels when the conversation starts outside GitBook, but the answer or follow-up belongs in your docs process.

### Supported platforms

Channels support these platforms:

* **Slack** for conversations and support threads.
* **GitHub** for issues, pull-request context, and discussion workflows.
* **Linear** for issue tracking and product feedback workflows.
* **Jira** for turning tickets into documentation updates.

Each platform uses the same core model.

GitBook receives supported events from the connected platform, gathers context from your knowledge, and responds through either [AI Assistant](/docs/ai-for-your-readers/gitbook-ai-assistant.md) or [GitBook Agent](/docs/gitbook-agent/overview.md).

### Roles and permissions

Channels support two roles:

* **Collaborator** — can make changes.
* **Support agent** — provides read-only information.

Choose the role based on what the channel needs to do.

#### Collaborator

Use **Collaborator** when the channel must help turn conversations into documentation work.

A collaborator channel can use GitBook Agent to help create or update docs work in GitBook, such as opening or progressing a change request.

#### Support agent

Use **Support agent** when the channel only needs to answer questions.

A support agent channel uses existing docs and connected knowledge to reply with read-only context. It does not make content changes.

### How it works

Channels handle incoming events from your connected platform.

An incoming event can be a new message, a mention, an issue update, or other supported activity from Slack, GitHub, Linear, or Jira.

GitBook processes those events in four steps:

{% stepper %}
{% step %}

### Receive an event

The connected platform sends a supported event to GitBook through the channel you installed.
{% endstep %}

{% step %}

### Gather context

GitBook looks up the relevant docs context and any other knowledge available to the site.
{% endstep %}

{% step %}

### Apply the channel role

If the channel is a **Support agent**, GitBook returns read-only information.

If the channel is a **Collaborator**, GitBook can also turn the conversation into docs work through GitBook Agent.
{% endstep %}

{% step %}

### Reply in the source tool

The response appears back in Slack, GitHub, Linear, or Jira, so the workflow stays in one place.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Exact event coverage depends on the platform and your early access rollout. If a trigger is not available in your workspace yet, it has not been documented publicly.
{% endhint %}

### Install and authorization

To install a channel, open your site dashboard and choose **Settings → Channels**.

Then choose the platform you want to connect.

Slack, GitHub, and Linear use an OAuth or app-install flow. GitBook sends you to the platform, you approve access, and then you return to GitBook to finish setup.

{% hint style="warning" %}
Platform-specific permission scopes and admin requirements are not fully documented yet.

Review the authorization screen carefully before you approve access.
{% endhint %}

{% tabs %}
{% tab title="Slack" %}
{% stepper %}
{% step %}

### Start the install

In **Settings → Channels**, select **Slack**.
{% endstep %}

{% step %}

### Authorize Slack

Sign in to Slack if needed.

Then choose the Slack workspace where you want to install the channel and approve the requested access.
{% endstep %}

{% step %}

### Finish setup in GitBook

After Slack redirects you back, finish the channel setup in GitBook.

Choose the role the channel should use and save the configuration.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="GitHub" %}
{% stepper %}
{% step %}

### Start the install

In **Settings → Channels**, select **GitHub**.
{% endstep %}

{% step %}

### Authorize GitHub

Sign in to GitHub if needed.

Then choose the personal account or organization where you want to install the GitBook app and approve the requested access.
{% endstep %}

{% step %}

### Finish setup in GitBook

After GitHub redirects you back, finish the channel setup in GitBook.

Choose the role the channel should use and save the configuration.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="Linear" %}
{% stepper %}
{% step %}

### Start the install

In **Settings → Channels**, select **Linear**.
{% endstep %}

{% step %}

### Authorize Linear

Sign in to Linear if needed.

Then choose the Linear workspace you want to connect and approve the requested access.
{% endstep %}

{% step %}

### Finish setup in GitBook

After Linear redirects you back, finish the channel setup in GitBook.

Choose the role the channel should use and save the configuration.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="Jira" %}
Connect Jira to your GitBook site, then add the `gitbook` label to a ticket. GitBook Agent uses the ticket to draft a change request for your team to review.

#### Before you start

You need the following:

* Admin access to your GitBook site, with Channels available and GitBook Agent enabled and unpaused.
* A Jira Cloud site, an Atlassian account email, and an API token for that account. The account needs access to the projects you want to use and permission to comment on and link issues.

#### Connect Jira

{% stepper %}
{% step %}

### Start setup

Open your site’s **Settings → Channels**. Under **Jira**, click **Add configuration**.

Jira uses the **Collaborator** role to help your team maintain documentation.
{% endstep %}

{% step %}

### Connect your Jira account

Enter the following details:

* **Jira site URL:** your Jira Cloud URL, such as `https://your-site.atlassian.net`.
* **Account email:** the email address of the Atlassian account that created the token.
* **Jira API token:** [create an API token in Atlassian](https://id.atlassian.com/manage-profile/security/api-tokens), then paste it here.

Click **Connect Jira**. Once the connection succeeds, GitBook shows the available projects.
{% endstep %}

{% step %}

### Finish setup in GitBook

Choose the projects you want GitBook to handle. Leaving the selection empty includes all projects accessible to the connected account. Only issues labeled `gitbook` start documentation work.

Set **Jira status when merged** to **Done**, or the equivalent status in your project’s workflow, so merging the change request also completes the ticket. Click **Save**. GitBook confirms with a “Jira configuration saved” message.
{% endstep %}
{% endstepper %}

#### Create a change request from a ticket

{% stepper %}
{% step %}

### Describe the documentation change

Open or create a Jira ticket in one of the projects covered by your configuration. Give it a clear title and describe what the docs should say.

For example, use the title “Document API key rotation” and include the rotation steps, who can perform them, and what happens to the old key.
{% endstep %}

{% step %}

### Add the `gitbook` label

Add `gitbook` to the ticket’s labels and save it.

GitBook Agent drafts a change request from the ticket’s title and description, then adds a comment and a link to the change request in Jira.
{% endstep %}

{% step %}

### Review the draft

Follow the link from Jira to open the change request in GitBook. Review the proposed changes, make any edits, and merge when the documentation is ready.
{% endstep %}
{% endstepper %}

#### Optional: request another edit from Jira

While the change request is open, add a comment containing `@gitbook` and the change you want. For example:

> @gitbook Add a note explaining when the old API key stops working.

GitBook Agent updates the linked draft and posts an update comment in Jira. Editing the ticket’s title or description alone does not request another edit.
{% endtab %}
{% endtabs %}

### Feedback and reactions

Reactions let your team give quick feedback on channel replies.

Use reactions when you want to signal whether a response was helpful.

That feedback helps GitBook understand which responses are working well in real workflows.

{% hint style="info" %}
The exact reaction mapping is not documented yet and can vary by platform during early access.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook.com/docs/gitbook-agent/channels.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.