Segment

Integrate your GitBook public documentation with your Segment pipeline.

Get started

Before proceeding, make sure you have created a Segment source. You can create one from the Segment dashboard as described in their documentation. Alternatively, you can re-use an existing one if you wish to.

Take note of the Segment source's write key as it will be needed during the configuration of the integration.

You can locate your source's write key as described in Segment's documentation.

Once installed and configured on a space, anytime a visitor access a page in your GitBook published content, the GitBook Segment integration will send [GitBook] space_view events (read more about the event in this section) to the Segment source you've chosen.

Next, you will need to install the Segment integration in GitBook and configure it to your needs. For this, follow the steps described in these sections:

• Step 1: install the integration

• Step 2: configure the integration

Feature overview

The GitBook Segment integration empowers your teams by connecting your GitBook public documentation to your Segment pipeline.

Automatic page view events on your public documentation

Each of your connected GitBook spaces will send a [GitBook] space_view event to the associated Segment source.

Track your users' actions across all your company websites

Each [GitBook] space_view includes the anonymousId property. If the active user has already visited one of your other company's websites, the anonymousId will match the one already set by Segment. Otherwise, GitBook will associate a new anonymousId for the user matching Segment's format.