GitbookIO / GitbookIO/integrations

Expose page ID in integration environment

Open
#538 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

improvement
Dominant language
TypeScript
Stars
131
Forks
96
Avg merge
7h 8m
Merged PRs (30d)
31

Description

Currently, it doesn't appear that there is a way to retrieve the page ID through the integration environment. For instance, I'm creating an integration that will be added to several separate pages that include task lists for various procedures. When the user visits the page for a specific procedure and clicks the button on that page, we want to be able to create a task list in a ticket in our ticketing system, pulled from the task list on the GitBook page. However, I've searched all through the documentation and the properties exposed to the integration, and I'm not able to find any reference to the page ID. Support confirmed that this isn't currently possible and suggested I request it here.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the integration environment and the properties currently exposed to integrations, then compare them with the integration documentation. The work is complete when an integration can retrieve the visited GitBook page ID and the supported property is documented for integration authors.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.