Clarify how host page query params reach journey_context - #142
Open
DeolaJ wants to merge 2 commits into
Open
Conversation
Spell out that query params do not have to be declared as context parameters in the Journey Builder, list the parameter names the Journey app reserves for itself, and point integrators at the console log they can use to verify what an embedding actually passed. Co-authored-by: Claude <noreply@anthropic.com>
DeolaJ
force-pushed
the
aa/url-params-journey-context
branch
from
July 31, 2026 09:01
5cd51ad to
414d1e8
Compare
DeolaJ
changed the title
The iframe embedding page had no Context Data section at all, even though the same merge rules and reserved parameter names apply there. Add one, and record the fix in the changelog of all three embedding pages. Co-authored-by: Claude <noreply@anthropic.com>
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.
Summary
Follow-up to a support question about a web component embedding whose
itellyidURL parameter never showed up in the submission'sjourney_context. The investigation turned up a code bug (fixed in journey-monorepo!5928) and three gaps in these docs.Changes
embedding.md— the legacy iframe page had no Context Data section at all, even thoughcontextDatais part of itsinit()options and the same rules apply. Added one, covering the merge with the page's query parameters, precedence on overlapping keys, and the reserved names.web-components.md— clarified that query parameters do not need to be declared as context parameters in the Journey Builder to reachjourney_context, and listed the parameters the Journey app reserves for itself (journeyId,journeyToken,previewId,nonce,asOrganizationId,embedSource,dataInjectionOptions,mode,lang,topBar,isEmbedded,debug,preview) — these are consumed rather than forwarded, so a tracking parameter must not reuse one.sdk.md— same clarification for.contextData().Changelogs — a
2026-07-31entry on all three embedding pages recording the fix. The wording differs per page because the impact did:.asWebComponent()/<epilot-journey>lost every query parameter when context data was set, while iframe embeds kept the ones declared as context parameters and lost the rest.Nothing was added to the root
CHANGELOG.md— that one is scoped to public REST APIs, entities and events, and this is embedding behaviour. Happy to add an entry there too if you'd rather have it in both places.Test plan
#context-dataon all three pages)