> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GitBook

> How to set up the GitBook connector, plus the actions and events that are available.

![GitBook](https://stackone-logos.com/api/gitbook/filled/svg)

v1.5.0[See changelog](https://docs.stackone.com/connectors/gitbook/changelog.md)

[61 actions](#actions) · [3 events](#events) · 1 auth method

Knowledge Management
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/gitbook/guides/connector-profile/api-key.md)
>
> Connect using your GitBook Personal Access Token. You can generate tokens from the Developer tools section in your GitBo...

Optionally, configure receiving Events for GitBook into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/gitbook/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/gitbook/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

61 actions

ActionDescription

List All Change Requests In A Space`gitbook_list_change_requests_in_space`

Get all change requests in a space

Get A Change Request By Its ID`gitbook_get_change_request`

Retrieve detailed information about a specific change request

Create A New Change Request`gitbook_create_change_request`

Create a new change request in a space

Update A Change Request`gitbook_update_change_request`

Update properties of an existing change request

Merge A Change Request`gitbook_merge_change_request`

Merge a change request into the main content

Get All Change Request Reviewers`gitbook_get_change_request_reviewers`

List requested reviewers for a change request

Remove A Reviewer From A Change Request`gitbook_remove_reviewer_from_change_request`

Remove a requested reviewer from a change request

List All Collections`gitbook_list_collections`

Get all collections in an organization

Get A Collection By Its ID`gitbook_get_collection`

Retrieve detailed information about a specific collection

Create A New Collection`gitbook_create_collection`

Create a new collection in an organization

Update A Collection`gitbook_update_collection`

Update properties of an existing collection

Delete A Collection`gitbook_delete_collection`

Delete a collection

List Collection User Permissions`gitbook_list_collection_user_permissions`

List users who have been added to a collection

Update A Collection User Permission`gitbook_update_collection_user_permission`

Update user permission level in a collection

Remove A User From A Collection`gitbook_remove_user_from_collection`

Remove a user's access to a collection

Get Space Git Info`gitbook_get_space_git_info`

Get Git Sync configuration and status for a space

Import A Git Repository`gitbook_import_git_repository`

Trigger a Git Sync import operation

Get Unified Credentials`gitbook_unified_get_me`

Return the authenticated identity and auth type for the current GitBook connection. Calls GET /user to confirm Personal...

List Unified Groups`gitbook_unified_list_groups`

List GitBook organization teams mapped to the IAM unified group schema, cursor-paginated. Wraps GET /orgs/\{organization\_...

Get Unified Group`gitbook_unified_get_group`

Retrieve a single GitBook team by id, mapped to the IAM unified group schema. Wraps GET /orgs/\{organization\_id}/teams/\{i...

List Unified Organizations`gitbook_unified_list_organizations`

List every GitBook organization the authenticated account is a member of, cursor-paginated. Wraps GET /orgs. Each entry...

Get Unified Organization`gitbook_unified_get_organization`

Retrieve a single GitBook organization by id, mapped to the IAM unified organization schema. Wraps GET /orgs/\{organizati...

List Unified Resource Types`gitbook_unified_list_resource_types`

List unified resource types in GitBook.

List Unified Resource Users`gitbook_unified_list_resource_users`

List unified resource users in GitBook.

List Unified Roles`gitbook_unified_list_roles`

Return the seven GitBook organization member roles as IAM role records (admin, create, edit, review, comment, read, gues...

Get Unified Role`gitbook_unified_get_role`

Retrieve a single GitBook organization role by its key (admin, create, edit, review, comment, read, guest). Returns the...

List Unified Users`gitbook_unified_list_users`

List GitBook organization members mapped to the IAM unified user schema, cursor-paginated. Wraps GET /orgs/\{organization...

Get Unified User`gitbook_unified_get_user`

Retrieve a single GitBook organization member by user id, mapped to the IAM unified user schema. Wraps GET /orgs/\{organi...

Update Unified User`gitbook_unified_update_user`

Update a GitBook organization member's role.

Delete Unified User`gitbook_unified_delete_user`

Remove a member from a GitBook organization.

List Organization Invites`gitbook_list_organization_invites`

List all invite links in an organization

Get An Organization Invite Link`gitbook_get_organization_invite_link`

Retrieve details of a specific invite link

Create A New Organization Invite`gitbook_create_organization_invite`

Create a new invite link for the organization

Invite Users To Organization`gitbook_invite_users_to_organization`

Invite users to organization by email

Deletes An Organization Invite`gitbook_delete_an_organization_invite`

Deletes an organization invite link

Get The List Of Organizations For The Currently Authenticated User`gitbook_list_authenticated_user_organizations`

List all organizations accessible to the authenticated user

Get An Organization By Its ID`gitbook_get_organization`

Retrieve detailed information about a specific organization

Update An Organization`gitbook_update_organization`

Update properties of an existing organization

List All Organization Members`gitbook_list_organization_members`

Get all members of an organization

Get An Organization Member By Its ID`gitbook_get_organization_member`

Retrieve detailed information about a specific organization member

Delete An Organization Member`gitbook_delete_organization_member`

Remove a member from an organization

List Space User Permissions`gitbook_list_space_user_permissions`

List users who have been added to a space

List All Space Users Permissions`gitbook_list_space_users_permissions`

List all users who can access a space with aggregated permissions

Update Space User Permissions`gitbook_update_space_user_permissions`

Update user permission level in a space

Remove A Space User`gitbook_remove_space_user`

Remove a user's access to a space

List All Spaces`gitbook_list_spaces`

Get all spaces in an organization

Get A Space By Its ID`gitbook_get_space`

Retrieve detailed information about a specific space

Create A New Space`gitbook_create_space`

Create a new documentation space in an organization

Update A Space`gitbook_update_space`

Update properties of an existing space

Delete A Space`gitbook_delete_space`

Delete a space and move it to trash

Get A URL Of The Content Of A Space As PDF`gitbook_get_url_of_content_of_space_as_pdf`

Generate and retrieve a temporary URL to export space content as PDF

List All Teams`gitbook_list_teams`

Get all teams in an organization

Get A Team`gitbook_get_team`

Retrieve detailed information about a specific team

Create A New Team`gitbook_create_team`

Create a new team in an organization

Update A Team`gitbook_update_team`

Update properties of an existing team

Delete A Team`gitbook_delete_team`

Delete a team from an organization

List All Team Members`gitbook_list_team_members`

Get all members of a team with their roles

Add A Member To A Team`gitbook_add_member_to_team`

Add a user to a team

Delete A Team Member`gitbook_delete_team_member`

Remove a member from a team

Get Profile Of Authenticated User`gitbook_get_profile_of_authenticated_user`

Get details about the authenticated user

Get A User By Its ID`gitbook_get_user`

Get publicly available information about a GitBook user

## Events

Tags

Select all
|
Clear

Content

Feedback

Sites

Webhooks

No tags found

3 events

EventDescriptionTags

Space Content Updated`gitbook_webhook_space_content_updated`

Triggered when content in a space is created or modified, including page edits and new revisions. It will be triggered o...

ContentWebhooks

Site View`gitbook_webhook_site_view`

Triggered when a user visits a page on a published GitBook site, including visitor details, URL, and referrer informatio...

SitesWebhooks

Page Feedback`gitbook_webhook_page_feedback`

Triggered when a user submits thumbs-up or thumbs-down feedback on a published site page, optionally with a comment.

FeedbackWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.