docs(provisioning): document path parameter for deep links endpoint#17321
Open
inkeep[bot] wants to merge 2 commits into
Open
docs(provisioning): document path parameter for deep links endpoint#17321inkeep[bot] wants to merge 2 commits into
path parameter for deep links endpoint#17321inkeep[bot] wants to merge 2 commits into
Conversation
Updates provisioning API docs to reflect PR #60740 which adds an optional `path` parameter to the deep links endpoint, allowing partners to redirect users to any specific in-app page instead of just the project home.
Contributor
|
Vale prose linter → found 0 errors, 15 warnings, 13 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 |
|---|---|---|---|
| 8:140 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 14:15 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 42:71 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 42:76 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 42:157 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 99:144 | warning | 'org's' is a possible misspelling. | PostHogBase.Spelling |
| 125:5 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 131:50 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 131:145 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 174:59 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 190:1 | suggestion | Address the reader directly. Use 'you' instead of 'The user'. | PostHogDocs.DirectAddress |
| 204:42 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 271:44 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 333:228 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 333:233 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 333:323 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 353:143 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 367:199 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 429:34 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 430:34 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 441:9 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 443:35 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 446:32 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 453:14 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 465:38 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 491:18 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 505:20 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 617:74 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
Contributor
Deploy preview
|
Contributor
|
Hey @MattBro! 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
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
Documents the new
pathparameter for the Provisioning API deep links endpoint (POST /api/agentic/provisioning/deep_links).What's new
Partners can now deep link users to any in-app path (e.g., a specific session recording, insight, or settings screen) instead of only the project home.
Documentation updates
pathfor targeting specific in-app pagespathin the request body with a realistic examplepurpose(now a free-form analytics label) and the newpathfieldinvalid_path(400) error codegetDeepLinkUrlto accept an optionalpathparameterRelated to: PostHog/posthog#60740
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.