Install an integration

How to install an integration in a space or a library.
Integrations can be installed in a single space, or in a number of spaces within an organization.
An integration installed in a single space will only work in that specific space, while an integration installed in multiple spaces will be able to perform actions across all selected spaces.

Installation on a space

Step 1: Click the Integrations button in the sub-navigation
Start by clicking on integrations in the space sub-navigation to install an integration on a single space.
GitBook space with Integrations button highlighted on the centre-top of sub-navigation panel.
Step 2: Review the integrations available and choose
Clicking the integrations button will bring you to the Integrations screen, which shows a list of all the integrations available to install.
Step 3: Select the integration and press install
Next, click on the integration (e.g Slack) you want to install on the space.
This will open up the integration's installation screen. Next, click the install button on the right-hand side of the screen.
An Integrations window open, Slack integration is shown with Install button highlighted in the bottom right corner
This will install the integration and connect it to your space.

Complete the configuration

Finally, you need to follow the instructions and select the options you need to complete the installation.
This can be done in the integration's installation configuration screen shown to you, specifically in the configuration and space configuration sections.
Installed Slack integration with a warning: finish configuring the integration

Installation on multiple spaces

You can install an integration on selected or all spaces in your library.
  • First, go to your personal account settings or organization settings screen.
  • Next, click the apps & integrations tab under your settings.
This will show the Integrations settings for your organization. You will be able to review already installed integrations and access their configuration, as well as install any new integrations.
GitBook settings open, with Integrations button highlighted on the left hand side
Click the install integration button on the top right-hand side to install an integration.
This will open up the apps & integrations screen showing a list of all the integrations available to install. From there the process is the same as installing an integration in a single space.
Once complete you can choose to either enable the integration on all spaces or install it on selected spaces.

Install on all spaces

To connect the integration to all spaces in the library, toggle install on all spaces in the space access section:
Slack integration window open with 'Install on all spaces' highlighted. The toggle is switched off meaning this feature has not been enabled.
This will automatically install it on all spaces and applies to current and future spaces.

Install on selected spaces

To connect the integration on selected spaces, click the pick a space dropdown in the space configuration section:
Integration window open with 'space configuration' highlighted. List of spaces that can be selected is visible.
Then, select a specific space from the dropdown options and click the add to space button to install the integration on the space.
Space configuration window open with single space selected.
Repeat the above for each of the spaces you want to connect to the integration.

Complete the configuration

Next, regardless of the option you chose, you will need to select the needed configuration options in both the configuration and space configuration sections of the installation screen to complete the installation.
You can apply different configuration options to each space. This can be done in the space configuration section. Use the space dropdown on the top right-hand corner to switch to another space:
Space configuration panel with list of settings such us 'notify visibility update' and 'notify content update' each has a toggle that is not switched on