Skip to content

docs: document agentic provisioning deep-link path parameter#17322

Draft
MattBro wants to merge 1 commit into
masterfrom
matt/deep-link-path-docs
Draft

docs: document agentic provisioning deep-link path parameter#17322
MattBro wants to merge 1 commit into
masterfrom
matt/deep-link-path-docs

Conversation

@MattBro
Copy link
Copy Markdown
Contributor

@MattBro MattBro commented Jun 5, 2026

Changes

The agentic provisioning deep_links endpoint now accepts an optional path to land a provisioned user on any in-app page after login, replacing the old fixed purpose enum (now just a free-form analytics label). This updates the Provisioning API doc:

  • adds the path request field with a real example, and demotes purpose to the analytics label it now is
  • adds a note on the mint-time and redirect-time validation and what's rejected (absolute URLs, //, backslashes, javascript:, control characters, whitespace)
  • adds the invalid_path (400) error code
  • updates the overview sequence diagram and the Node getDeepLinkUrl helper to take an optional path

Shipped in PostHog/posthog#60740. Facts verified against the merged code.

Checklist

  • I've read the docs and/or content style guides.
  • Words are spelled using American English
  • Use relative URLs for internal links
  • I've checked the pages added or changed in the Vercel preview build
  • If I moved a page, I added a redirect in vercel.json (n/a — no page moved)

Agent-authored (Claude Code); requires human review before merge.

The deep_links endpoint now takes an optional `path` to land a provisioned
user on any in-app page after login (replacing the fixed `purpose` enum).
Update the Provisioning API doc: request fields, example, validation, the
`invalid_path` error, the sequence diagram, and the Node helper.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 5, 2026

Deploy preview

Status Details Updated (UTC)
🟢 Ready View preview Jun 05, 2026 03:20PM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 5, 2026

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!

contents/docs/integrate/provisioning.mdx — 0 errors, 15 warnings, 13 suggestions
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
98:144 warning 'org's' is a possible misspelling. PostHogBase.Spelling
124:5 warning Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. PostHogBase.ProductNames
130:50 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
130:145 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
173:26 warning 'OAuth' is a possible misspelling. PostHogBase.Spelling
189:1 suggestion Address the reader directly. Use 'you' instead of 'The user'. PostHogDocs.DirectAddress
203:42 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
270:44 warning 'OAuth' is a possible misspelling. PostHogBase.Spelling
332:228 warning Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. PostHogBase.ProductNames
332:233 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
344:224 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
350:50 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
365:199 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
427:28 warning Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. PostHogBase.ProductNames
428:30 warning Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. PostHogBase.ProductNames
439:9 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
441:35 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
444:32 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
451:14 warning Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. PostHogBase.ProductNames
463:38 warning 'OAuth' is a possible misspelling. PostHogBase.Spelling
489:18 warning Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. PostHogBase.ProductNames
501:20 warning Use 'PostHog' instead of 'posthog'. Vale.Terms
622:74 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress
622:177 suggestion Address the reader directly. Use 'you' instead of 'the user'. PostHogDocs.DirectAddress

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant