-
Notifications
You must be signed in to change notification settings - Fork 84
Updates for Canvas context articles #10588
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
_docs/_user_guide/engagement_tools/canvas/canvas_components/context.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/engagement_tools/canvas/create_a_canvas/context_and_event_properties.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/engagement_tools/canvas/create_a_canvas/create_a_canvas.md
Outdated
Show resolved
Hide resolved
samuelshih
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💯
_docs/_user_guide/engagement_tools/canvas/create_a_canvas/context_and_event_properties.md
Outdated
Show resolved
Hide resolved
...eate_a_canvas/canvas_entry_properties_event_properties/canvas_persistent_entry_properties.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request updates Braze documentation to reflect the transition from "Canvas entry properties" terminology to "context" as part of the Canvas Context feature release scheduled for January 2026. The PR updates terminology across documentation files, API references, and code examples, while maintaining backward compatibility references.
Key changes:
- Replaces
canvas_entry_propertieswithcontextin Liquid syntax and API parameters throughout documentation - Adds a new Canvas context object API reference file with an alias to the old URL
- Updates the important alerts include to reflect that Canvas Context is now generally available (not early access)
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
_includes/canvas_entry_event_properties.md |
Updates Liquid syntax and examples to use context instead of canvas_entry_properties |
_includes/alerts/important_alerts.md |
Updates alert text to reflect Canvas Context general availability |
_docs/_user_guide/personalization_and_dynamic_content/liquid/supported_personalization_tags.md |
Updates personalization tags table to reference context |
_docs/_user_guide/engagement_tools/canvas/create_a_canvas/create_a_canvas.md |
Updates Canvas entry schedule documentation to use context terminology |
_docs/_user_guide/engagement_tools/canvas/create_a_canvas/context_and_event_properties.md |
Renames article and updates all references from canvas entry properties to context |
_docs/_user_guide/engagement_tools/canvas/create_a_canvas/canvas_entry_properties_event_properties/canvas_persistent_entry_properties.md |
Updates historical reference to point to new context documentation |
_docs/_user_guide/engagement_tools/canvas/canvas_components/message_step.md |
Updates message step documentation to reference context properties |
_docs/_user_guide/data/activation/catalogs/catalog_triggers/price_drop_notifications.md |
Updates catalog trigger examples to use context Liquid syntax |
_docs/_user_guide/data/activation/catalogs/catalog_triggers/back_in_stock_notifications.md |
Updates catalog trigger examples to use context Liquid syntax |
_docs/_partners/data_and_analytics/workflow_automation/zapier.md |
Updates Zapier integration example to use context parameter |
_docs/_hidden/archived_layouts/api_glossary.md |
Updates API glossary examples to use context parameter |
_docs/_api/objects_filters/recipient_object.md |
Updates recipient object to reference context instead of canvas_entry_properties |
_docs/_api/objects_filters/context_object.md |
New file documenting the Canvas context object with alias to old URL |
_docs/_api/objects_filters.md |
Updates objects listing to reference Canvas context object |
_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md |
Updates API endpoint to use context parameter |
_docs/_api/endpoints/messaging/schedule_messages/post_schedule_triggered_canvases.md |
Updates API endpoint to use context parameter |
Comments suppressed due to low confidence (1)
_docs/_user_guide/engagement_tools/canvas/create_a_canvas/context_and_event_properties.md:55
- The link in this line should be updated from
canvas_entry_properties_event_propertiestocontext_and_event_propertiesto match the updated file path.
_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md
Outdated
Show resolved
Hide resolved
_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/engagement_tools/canvas/canvas_components/message_step.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/engagement_tools/canvas/create_a_canvas/create_a_canvas.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/engagement_tools/canvas/canvas_components/message_step.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/engagement_tools/canvas/create_a_canvas/create_a_canvas.md
Outdated
Show resolved
Hide resolved
…te_a_canvas.md Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Why are you making this change? (required)
Update mentions of Canvas entry properties to context, add alert to _includes
Related PRs, issues, or features (optional)
Feature release date (optional)
Contributor checklist
Submitting for review
If your PR meets the above requirements, select Ready for review, then add a reviewer:
@braze-inc/docs-teamin a comment below.braze-inc/docs-teaminstead.Thanks for contributing! We look forward to reading your work.