Configure the Slack integration

Install the integration

To start using the Slack integration, you will need to install it in your GitBook library or just on a single space. To do this, follow the steps described in the install an integration section.

Once it is installed, you will need to connect it to your Slack workspace, select the channels to which the integration will be posting the status updates, and tweak other configuration options to your need, to complete the installation by configuring it.

Configure the integration

After installing the integration to your space or GitBook library, you will first need to authorize the Slack integration to connect to your Slack workspace.

Step 1: Authorize the connection

In the configuration section of the integration's configuration screen, click the authorize button.

Integration settings with Configuration highlighted. The integration between Slack and GitBook requires authorization and the button is visible to the right of the text.

Step 2: Grant the GitBook Slack app access to your workspace

This will open up a pop-up window requesting permission for the GitBook Slack app to access your Slack workspace.

Next, make sure to select the correct Slack workspace from the dropdown menu located at the top right-hand side of the pop-up.

Then, click the allow button to grant permission and complete the authorization flow.

This will bring you back to the integration's configuration screen if the authorization was successful.

Slack authorisation flow open with 'Gitbook is requesting permission to access your Slack workspace'.

After successful authorization, the GitBook Slack app will be automatically installed in your Slack workspace.

Step 3: Choose a default Slack channel

Next, you have the option to select the default Slack channel to which the integrations will be posting messages to when no channel is selected individually for each space.

Click the default channel dropdown in the configuration section and select the default channel from the dropdown options.

Configuration settings of the integration settings open, with default channel settings and an arrow which expands to a search settings. One space called 'general' is selected

Step 4: Select configuration options for specific spaces (optional)

Next, you can select different configuration options to apply individually to each of the spaces. You can do this in the space configuration section.

You can for example select a specific Slack channel to which the integration will be posting the selected space updates.

Additionally, you can choose what type of space updates will trigger the delivery of messages to the selected Slack channel.

To switch to another space and configure its individual configuration options, click the space dropdown at the top right-hand corner and select the specific space:

Space configuration window open, with a drop down list of spaces. The integration is already installed in 'Jet-Stream Docs' but user can select other spaces to access it's own configurations.

Last updated 2 years ago

Was this helpful?