Skip to main content

​
Prerequisites

Before continuing, you should have already completed the following for this connector:
1

Configure the Connector

Enable the connector and set up its connector profile in your project. See Managing Connectors.

Connector Profile

GitBook - API Key
2

Link an Account

Connect an account using StackOne Hub or Auth Link.

Link Account

GitBook - API Key

​
Sign in to GitBook

Sign in to your GitBook account.

GitBook sign-in page

​
Access Integrations

Navigate to the Integrations page.

  • Click Settings in the left sidebar under Organization.
  • Click Integrations in the left sidebar under Organization.
  • Search for Webhook in the search bar and click the Webhook integration.
GitBook Settings page showing Integrations

​
Configure the Webhook

Install and configure the Webhook integration for Space, Site, and Page Feedback events.

Installed Webhook integration
1

Webhook configuration for Space

On the Install Webhook modal, select Install on the specific space(s) and click the Install button.

Webhook for Install on the specific space(s)
2

Paste the Webhook URL

In the Configure space dialogue under Space configuration:

  • Paste the Native Webhook URL you copied from StackOne Hub into the Webhook URL field.
  • Enable the Content updates toggle under Select which events you want to receive for this space.
  • Click Save Configuration to save.
Enable content updates
3

Webhook configuration for Site and Page Feedback

On the Install Webhook modal, select Install on the specific site(s) and click the Install button.

Webhook for Install on the specific site(s)
4

Enable the Site and Page Feedback events

The Webhook URL field will be automatically populated. If not, paste the Native Webhook URL you copied from StackOne Hub.

  • Enable the Site views and Page feedbacks toggles under Select which events you want to receive for this site.
  • Click Save Configuration to save.
Enable site and page feedback events

​
Complete the Webhook configuration

After saving the configurations for the space and sites, the webhook setup is complete.

Webhook configuration success message

​
Available webhook events

The following GitBook events can be enabled. Only events selected in StackOne are delivered — GitBook will not send events that are not subscribed. Events are configured per space or site installation.

1

Content events

Events related to space content changes.

  • Space Content Updated (space_content_updated) — Fired when content in a space is created or modified, including page edits and new revisions.
2

Analytics events

Events related to published site page views.

  • Site View (site_view) — Fired when a user visits a page on a published GitBook site.
3

Feedback events

Events related to user feedback on published pages.

  • Page Feedback (page_feedback) — Fired when a user submits thumbs-up or thumbs-down feedback on a published site page, optionally with a comment.

​
Verify

Your Connector should now be able to receive and process events. Try triggering an event and you should see an Event appear in the Connector logs.