Slack (beta)

The GitBook integration for Slack lets you curate knowledge into your knowledge base, right from the source

This feature is no longer maintained in GitBook and is subject to change.

The GitBook Slack integration helps you collect, review, and share information to and from your company’s knowledge base. With a set of commands you can run within your Slack Workspace, it’s easy to add or use information that’s useful for your team.

GitBook AI will summarize information that you or your team add to your knowledge base, turning a series of messages into a context-rich document. And when you or a colleague need to learn more about something, you can ask GitBook AI and get a plain-text summary, with all the background needed to dive in deeper.

GitBook AI & the Slack integration are available as part of the Pro plan and Enterprise plan. To find out more, visit our pricing page.

Installation & Configuration

You can install the Slack integration right from the integrations page in GitBook.

After installing the Slack integration to GitBook, you’ll see a prompt to authorize your user account and install the Slack bot into your organization’s Slack workspace.

After installing the integration into your Slack workspace, you can use the included Slack commands, or invite the GitBook Slack bot to the channels you’d like to interact with it in, and tag it to ask a question. See the FAQs at the bottom to learn more about where you can use the GitBook Slack bot.

You need to be a workspace owner or workspace admin in Slack to install the GitBook Slack bot into your team’s workspace.

If you had installed the GitBook Slack integration prior to October 7th 2023, you’ll need to uninstall and reinstall the integration to get the latest version.

Adding information to your knowledge base

You can add information to your team’s knowledge base by calling the GitBook Slack bot. You can invoke the bot in different ways, in both public or private channels.

How to add information using the GitBook Slack bot

Calling @GitBook save from within thread will summarize context and data from that thread into your team’s knowledge base as a snippet.

Calling the GitBook bot will work from any thread within a public channel or private channel. In a private channel, make sure to invite the GitBook bot in order for it to work.

How to add information using the Slack shortcut

You can also add data to your team’s knowledge base using Slack shortcuts. Simply click the More actions button from a thread in Slack, click More message shortcuts…, and search for the GitBook bot. You can call the shortcut from any message in a thread — the GitBook bot will save the entire thread.

How to summon GitBook knowledge within Slack

As well as saving information to your team’s knowledge base, you can also recall anything from your knowledge base from within Slack, while you work.

Using the GitBook Slack command

Calling /gitbook [question] will allow you to get a private, AI-generated response to your question, based on the information in your team’s knowledge base.

The answer in Slack will only be visible to you — which is useful if you need a quick bit of context on something without polluting your team’s channel.

After GitBook returns your answer, you’ll have the option to share your answer to the channel, if you think the answer is helpful for others.

The Slack command will only work in public channels, private channels, and direct messages. It will not work inside of a thread.

Using the GitBook Slack bot

You can call the GitBook Slack bot directly with @GitBook [question] to receive a public answer in any channel or thread.

After asking your question in a channel or thread, everyone that has access to that channel will be able to see it and the answer.

Calling the GitBook Slack bot will only work in public channels, private channels, and threads. It will not work inside of a direct message.

Messaging the GitBook Slack bot directly

You can also ask questions to the GitBook Slack bot in a direct message. After starting a direct message with the GitBook Slack bot, simply ask your question. GitBook AI will generate and return an answer privately in seconds.

FAQs

Why isn’t the /gitbook [question] or @GitBook save command working in Slack?

When interacting with the GitBook Slack integration, there are a few things to keep in mind:

• The /gitbook [question] command does not work in threads. It will only work in public and private channels or direct messages.

• The @GitBook save command does not work in top-level channels or direct messages. It will only work inside threads in public or private channels.

How do permissions work with the Slack integration?

The Slack integration does not take into account individual user permissions in GitBook. This is because there is no direct link or tie between a Slack user and a GitBook user. However, when you set up the Slack integration you can specify which spaces it has access to, which can help mitigate any security risks if you have sensitive content.