Skip to main content

Data Source

The GitBook connector enables you to ingest documentation content, space metadata, page hierarchies, revision histories, and other structured data from your GitBook organization. This connector is particularly useful for applications that need to sync GitBook content into a data warehouse, audit documentation changes, or analyze knowledge base usage across teams.

The GitBook connector enables you to ingest documentation content, spaces, pages, and organizational data from GitBook. Follow the instructions below to create a new data flow that ingests data from a GitBook source in Nexla.
git_book_api.png

GitBook

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the GitBook connector tile from the list of available connectors. Then, select the credential that will be used to connect to the GitBook instance, and click Next; or, create a new GitBook credential for use in this flow.

  3. In Nexla, GitBook data sources can be created using pre-built endpoint templates, which expedite source setup for common GitBook endpoints. Each template is designed specifically for the corresponding GitBook endpoint, making data source setup easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    GitBook sources can also be configured manually, allowing you to ingest data from GitBook endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common GitBook endpoints. Each template is designed specifically for the corresponding GitBook endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get Current User

    Returns the profile information of the authenticated GitBook user, including name, email, and account details.

    • Sends a GET request to https://api.gitbook.com/v1/user and returns the authenticated user's profile object.
    • Response data is located at $ (the top-level response object).

    No parameters are required. This endpoint is useful for verifying connectivity and confirming the identity of the authenticated API token holder.

    List Organizations

    Returns a list of all GitBook organizations that the authenticated user is a member of.

    No parameters are required. Use the returned organization IDs with other endpoints that require an Organization ID parameter.

    Get Space Traffic Insights

    Returns traffic and analytics data for a specific GitBook space, useful for measuring documentation engagement and page views.

    Traffic insights may be subject to data retention limits depending on your GitBook plan. Use List Organization Spaces to retrieve valid Space IDs.

    Get Space Content

    Returns the full content structure and page hierarchy for a specific GitBook space, enabling documentation content synchronization.

    Returns the full page tree including nested pages. For very large spaces, the response may be large — consider specifying a Path to Data to extract only the needed fields.

    List Organization Members

    Returns a list of members in a specific GitBook organization, including their roles and join dates.

    Use the List Organizations endpoint to retrieve valid Organization IDs. Results are paginated using the standard GitBook pagination cursor.

    Get Space Current Revision

    Retrieves the current revision and content metadata for a GitBook space, useful for change detection and documentation versioning workflows.

    • Sends a GET request to https://api.gitbook.com/v1/spaces/{spaceId}/content/v and returns the revision metadata object.
    • Response data is located at $ (the top-level response object).
    • Configure the following parameters: Space Id — the unique identifier of the space; Include metadata — whether to include additional metadata; Include computed fields — whether to include computed fields in the response.

    The Include metadata and Include computed fields parameters are optional. This endpoint is particularly useful for detecting content changes since the last sync.

    List Organization Spaces

    Lists all spaces belonging to a GitBook organization — the canonical way to discover which spaces exist before reading their content or analytics.

    Use the List Organizations endpoint to retrieve valid Organization IDs. Returned Space IDs can be used with other space-scoped endpoints.

    List Space Change Requests

    Lists open change requests (draft editing branches) for a specific GitBook space, enabling documentation workflow monitoring.

    Change requests represent pending edits that have not yet been merged into the published space content.

    List Organization Collections

    Lists all collections within a GitBook organization. Collections are groups of related spaces used to organize documentation.

    Use the List Organizations endpoint to retrieve valid Organization IDs. Each collection includes its name, visibility settings, and member spaces.

    List Organization Teams

    Lists all teams defined within a GitBook organization, useful for auditing access controls and team membership.

    Use the List Organizations endpoint to retrieve valid Organization IDs. Team IDs returned here can be used with space permission endpoints.

    List Space User Permissions

    Lists all users and their assigned permission roles on a specific GitBook space, enabling access control auditing.

    Use the List Organization Spaces endpoint to retrieve valid Space IDs. This endpoint returns only user-level permissions, not team-level permissions.

    List Space Comments

    Lists inline comments and discussion threads on a specific GitBook space, enabling documentation review workflow tracking.

    Inline comments are anchored to specific pages or sections within a space. Each comment record includes the author, creation time, and page reference.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

GitBook sources can also be configured to ingest data from any valid GitBook API endpoint. The GitBook REST API is accessible at https://api.gitbook.com/v1/ and supports retrieval of spaces, pages, organizations, users, change requests, and more. Configuration options available for GitBook sources allow them to be fully customized to suit any use case — including using chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

First, select the method that will be used for calls to the GitBook API from the Method pulldown menu. For data retrieval from GitBook, the most common method is:

  • GET: For retrieving spaces, pages, organizations, users, revisions, and other GitBook resources.
  • POST: For creating content or triggering actions such as importing content or creating change requests.

API Endpoint URL​

  1. Enter the URL of the GitBook API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

    Common GitBook API endpoint URL patterns include:

    • https://api.gitbook.com/v1/orgs/{'{organizationId}'}/spaces — List all spaces in an organization.
    • https://api.gitbook.com/v1/spaces/{'{spaceId}'}/content — Retrieve the full content of a space.
    • https://api.gitbook.com/v1/spaces/{'{spaceId}'}/pages/{'{pageId}'} — Retrieve a specific page.
    • https://api.gitbook.com/v1/orgs/{'{organizationId}'}/members — List members of an organization.
    • https://api.gitbook.com/v1/spaces/{'{spaceId}'}/revisions — List revision history for a space.

    Replace {'{organizationId}'}, {'{spaceId}'}, and {'{pageId}'} with the actual IDs from your GitBook account. You can find organization and space IDs in the GitBook URL when browsing your content, or by querying the /v1/orgs endpoint.

    The GitBook API requires all requests to be made over HTTPS. Ensure the API endpoint URL begins with https://api.gitbook.com/v1/. For complete API endpoint reference documentation, see the GitBook API Reference.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros — all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/time macros are useful when querying GitBook endpoints that accept date-based filter parameters, such as filtering revisions or change requests by date range.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime.
    • {now-1} – The datetime one time unit before the current datetime.
    • {now+1} – The datetime one time unit after the current datetime.
    • custom – Datetime macros can reference any number of time units before or after the current datetime — for example, enter (now-4) to indicate the datetime four time units before the current datetime.

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro — i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu — for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are particularly useful when iterating over multiple GitBook spaces or pages — for example, referencing a list of space IDs from a prior Nexla source to fetch content from each space in sequence.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the GitBook API endpoint is needed, you can designate the part of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful for GitBook API responses that wrap records inside a top-level items or data array alongside pagination metadata.

For example, when retrieving a list of spaces, the GitBook API returns an object with an items array containing the space records along with pagination details. By entering the path to the relevant data, you can configure Nexla to treat each element of the items array as a record.

Path to Data is essential when GitBook API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records. Most GitBook list endpoints return records in an items array at the top level of the response JSON.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.items[*] to access the top-level items array in GitBook list responses).
    Path to Data Example:

    For a GitBook API response that returns a list of spaces, the response includes a top-level items array. Enter $.items[*] as the path to treat each space as a separate record.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content and format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the GitBook API response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. GitBook list responses typically include pagination metadata such as next, previous, and total fields alongside the items array. This metadata can be preserved to help track pagination state or response context.

Metadata paths are particularly useful for preserving GitBook API response context like pagination cursors, total record counts, or request timestamps that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be required for GitBook API versioning or to specify content type expectations.

    You do not need to include the Authorization header — this is automatically added by Nexla using the API token from the configured credential. The GitBook API currently uses a single API version, so no versioning headers are typically required.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows you to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched and displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new GitBook data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.