GitBook Agent is here! Introducing a new way to ideate, plan, and ship docs.
Find out more
LogoLogo
ProductPricingLog inSign up
  • Documentation
  • Developers
  • Guides
  • Changelog
  • Developer documentation
  • Build an integration
    • Quickstart
    • Install the CLI
      • CLI reference
    • Configure your integration
    • Develop your integration
      • ContentKit
        • Component reference
        • Markdown
      • Integration runtime
      • Client library
        • GitBook methods
    • Publish your integration
    • Submit your integration for review
    • Concepts
    • Guides
      • Create a custom unfurl action
      • Create interactive blocks
      • Receive webhook notifications
      • Work with HTTP requests
  • GitBook API
    • Quickstart
    • API reference
      • Organizations
        • Organization members
        • Organization invites
        • Organization AI ask
      • Docs sites
        • Site share links
        • Site structure
        • Site auth
        • Site preview
        • Site customization
        • Site spaces
        • Site sections
        • Site section groups
        • Site redirects
        • Site MCP servers
        • Site ads
        • Site users
        • Site insights
        • Site AI
        • Site AI ask
      • Collections
        • Collection users
        • Collection teams
      • Spaces
        • Space content
        • Space comments
        • Space embeds
        • Space users
        • Space teams
        • Space integrations
        • Git
      • Change requests
        • Change request content
        • Change request contributors
        • Change request reviewers
        • Change request comments
      • Translations
        • Glossary
      • Imports
      • Integrations
      • URLs
      • OpenAPI
        • OpenAPI spec versions
      • Conversations
      • Custom fonts
      • Subdomains
      • Users
      • Teams
        • Team members
      • SSO
      • Storage
      • Custom hostnames
      • System info
      • Download OpenAPI spec
    • Authentication
    • Rate limiting
    • Pagination
    • Errors
    • Concepts
    • Guides
      • Track advanced analytics with GitBook's Events Aggregation API
  • Resources
    • ContentKit playground
    • GitHub examples
Powered by GitBook
On this page
Edit on GitHub
  1. Build an integration

Concepts

Learn about different GitBook concepts related to GitBook integrations

Last updated 8 months ago

Was this helpful?

LogoLogo

Resources

  • Showcase
  • Enterprise
  • Status

Company

  • Careers
  • Blog
  • Community

Policies

  • Subprocessors
  • Terms of Service
CtrlK

Was this helpful?

Throughout the GitBook developer platform and its documentation, you'll encounter various concepts, variables, and terms.

Term
Description
Where to Find

How integrations are rendered in GitBook

Rendering of custom blocks is controlled in the integration's code and executed in the GitBook backend.

<organizationId>

A unique identifier of an Organization in GitBook.

Found in the URL of any space or via the "Copy org ID" button in the organization settings. Example: https://app.gitbook.com/o/<organizationId/s/<sapceId>

<spaceId>

A unique identifier of a Space in GitBook.

Found in the URL of any space or via the "Copy space ID" button in the upper-right dropdown in a space. Example: https://app.gitbook.com/o/<organizationId/s/<sapceId>

<userId>

A unique identifier of a User in GitBook.

Retrieved from the "GET Current User" API endpoint or via the "Copy user ID" button from your organization settings.

gitbook-manifest.yaml

A required file in a GitBook integration containing metadata for publishing and developing your app. Automatically generated from the CLI when running gitbook new.

See the Configurations section for more info.

.gitbook-dev.yaml

A required file in a GitBook integration that includes configuration for local development. Automatically generated from the CLI when running gitbook dev.

See the section for more info.

Development