docs(cdp): Add OAuth2 authentication to Custom REST source#18124
Open
inkeep[bot] wants to merge 1 commit into
Open
docs(cdp): Add OAuth2 authentication to Custom REST source#18124inkeep[bot] wants to merge 1 commit into
inkeep[bot] wants to merge 1 commit into
Conversation
Add documentation for OAuth2 authentication in Custom REST sources, reflecting the server-managed credential handling from PR #66792: - Add OAuth2 row to the authentication type table - Add OAuth2 configuration subsection with grant types and field reference - Add troubleshooting section for OAuth2 token errors and reconnection
Contributor
Deploy preview
|
Contributor
|
Vale prose linter → found 0 errors, 19 warnings, 0 suggestions in your markdown Full report → Copy the linter results into an LLM to batch-fix issues. Linter being weird? Update the rules!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 12:268 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 20:4 | warning | 'Create a custom REST source' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 29:118 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 52:6 | warning | 'OAuth2 configuration' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 87:13 | warning | 'JSONPath' is a possible misspelling. | PostHogBase.Spelling |
| 91:12 | warning | 'Paginator' is a possible misspelling. | PostHogBase.Spelling |
| 96:46 | warning | 'JSONPath' is a possible misspelling. | PostHogBase.Spelling |
| 97:44 | warning | 'JSONPath' is a possible misspelling. | PostHogBase.Spelling |
| 98:26 | warning | 'params' is a possible misspelling. | PostHogBase.Spelling |
| 108:12 | warning | 'JSONPath' is a possible misspelling. | PostHogBase.Spelling |
| 121:97 | warning | 'JSONPath' is a possible misspelling. | PostHogBase.Spelling |
| 122:105 | warning | 'JSONPath' is a possible misspelling. | PostHogBase.Spelling |
| 130:65 | warning | 'JSONPath' is a possible misspelling. | PostHogBase.Spelling |
| 130:112 | warning | 'params' is a possible misspelling. | PostHogBase.Spelling |
| 139:12 | warning | 'paginator' is a possible misspelling. | PostHogBase.Spelling |
| 139:62 | warning | 'JSONPath' is a possible misspelling. | PostHogBase.Spelling |
| 153:30 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 174:5 | warning | 'OAuth2 token errors' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 182:5 | warning | 'Have a question? Ask PostHog AI' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
Contributor
Bundle reportTotal JS (gzip)6.29 MiB (+0.0 KiB / +0.0%) Eager graph (static-import closure per entrypoint)
Largest modules in the
|
| Module | Size |
|---|---|
css ./node_modules/.pnpm/css-loader@5.2.7_webpack@5.101.3/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[1]!./node_modules/.pnpm/postcss-loader@4.3.0_postcss@8.5.6_webpack@5.101.3/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[2]!./src/styles/global.css |
708.0 KiB |
./src/components/Stickers/Stickers.tsx |
696.4 KiB |
./.cache/caches/gatsby-plugin-mdx/mdx-scopes-dir/31a094f140f119e73085d847ae81b99b.js + 2 modules |
579.3 KiB |
./node_modules/.pnpm/@radix-ui+react-icons@1.3.2_react@18.3.1/node_modules/@radix-ui/react-icons/dist/react-icons.esm.js |
481.4 KiB |
./node_modules/.pnpm/@codemirror+view@6.38.2/node_modules/@codemirror/view/dist/index.js |
458.1 KiB |
./node_modules/.pnpm/rehype-raw@7.0.0/node_modules/rehype-raw/lib/index.js + 29 modules |
395.1 KiB |
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.cjs.js |
364.8 KiB |
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.es.js |
354.8 KiB |
./src/hooks/useCustomers.tsx + 54 modules |
353.9 KiB |
./node_modules/.pnpm/react-markdown@8.0.7_@types+react@16.14.66_react@18.3.1/node_modules/react-markdown/lib/react-markdown.js + 88 modules |
351.4 KiB |
./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js |
281.9 KiB |
./src/components/ProductComparisonTable/index.tsx + 116 modules |
267.6 KiB |
./node_modules/.pnpm/@codesandbox+sandpack-react@2.20.0_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@codesandbox/sandpack-react/dist/index.mjs |
266.6 KiB |
./node_modules/.pnpm/d3@7.9.0/node_modules/d3/src/index.js + 208 modules |
247.4 KiB |
./src/components/Pricing/PricingSlider/Slider.tsx + 87 modules |
239.9 KiB |
Eager-graph budgets are report-only until a baseline is established. Sizes are gzip of public/**/*.js; eager size is webpack module source bytes.
MarconLP
approved these changes
Jul 2, 2026
Contributor
|
Hey @MarconLP! This docs PR was generated for you by an agent. You're responsible for reviewing and merging it into production.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
This PR adds documentation for OAuth2 authentication support in Custom REST sources, based on PR #66792.
What's documented
OAuth2 authentication type — Added to the authentication options table with supported fields (Client ID, Client secret, Token URL, Grant type, Refresh token, Scopes)
OAuth2 configuration section — New subsection explaining:
client_credentials(machine-to-machine) andrefresh_token(pre-obtained token)authorization_codeis not supportedOAuth2 troubleshooting — New section explaining:
TOKEN_REFRESH_FAILEDerror)Key user-facing behavior
OAuth2 credentials are server-managed — there is no separate integration resource to create or manage. Users simply enter credentials directly in the source settings, and to reconnect after token expiration, they re-enter the client secret and/or refresh token in the same place.
This PR was created by the Inkeep Content Writer agent, which is maintained by the Docs and Wizard team. Please reach out on Slack for help if needed.