feat: Add secure event transform docs#14397
Open
benjackwhite wants to merge 13 commits intomasterfrom
Open
Conversation
Document the new secure event validation transformation from PR #42818. Includes installation steps, client-side implementation examples, secret rotation guide, and FAQs.
- Add templateId to frontmatter - Wrap Configuration/FAQ/snippets in HideOnCDPIndex - Add standard PostHogMaintained and FeedbackQuestions snippets - Remove showTitle that was causing sidebar issues - Add Installation section for consistency
Emphasize that enforce mode should only be enabled after validating that all events have correct verification hashes, as it will drop any events without valid hashes.
Document the new secure event validation transformation from PR #42818. Includes installation steps, client-side implementation examples, secret rotation guide, enforcing secure mode warning, and FAQs.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Add info callout explaining this approach only works for logged-in users - Update enforce mode warning to explicitly mention anonymous users will be dropped - Clarify that anonymous users cannot be securely validated
…d flow - Use MultiLanguage component for Node.js/Python examples - Clarify hash must be generated server-side and passed to frontend - Add separate section showing how to use the hash with JS SDK in browser - Emphasize never exposing the shared secret in client-side code
The transformation uses $distinct_id_hash as the property name, not $verification_hash. Updated all references and code examples.
- Clarify the hash must be included with every event - Use register() to set as super property instead of passing via identify() - Link to super properties documentation
- Move register() before identify() so hash is set before any events fire - Add new section for backend SDK usage showing how to include the hash directly as a property with each capture call
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
2 participants
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
Document the new secure event validation transformation from PR #42818. Includes installation steps, client-side implementation examples, secret rotation guide, enforcing secure mode warning, and FAQs.
Checklist
vercel.jsonArticle checklist