Skip to content

Conversation

@lydia-xie
Copy link
Contributor

@lydia-xie lydia-xie commented Sep 19, 2025

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)

  • January 2026

Contributor checklist

  • I confirm that my PR meets the following:
    • I signed the Contribution License Agreement (CLA).
    • My style and voice follow the Braze Style Guide.
    • My content contains correct spelling and grammar.
    • All links are working correctly.
    • If I renamed or moved a file or directory, I set up URL redirects for each file.
    • If I updated or replaced an image, I did not remove the original image file from the repository. (For more information, see Updating an image).
    • If my PR is related to a paid SKU, third party, SMS, AI, or privacy, I have received written approval from Braze Legal.

Submitting for review

If your PR meets the above requirements, select Ready for review, then add a reviewer:

  • Non-Braze contributors: Tag @braze-inc/docs-team in a comment below.
  • Braze employees: Have any relevant subject matter experts (like engineers or product managers) review your work first, then add the tech writer assigned to your specific vertical. If you're not sure which tech writer to add, you can add braze-inc/docs-team instead.

Thanks for contributing! We look forward to reading your work.

@lydia-xie lydia-xie self-assigned this Sep 19, 2025
Copy link

@samuelshih samuelshih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

@lydia-xie lydia-xie requested a review from samuelshih October 8, 2025 17:08
@lydia-xie lydia-xie changed the title [BD-5165] Updates for Canvas context articles Updates for Canvas context articles Oct 15, 2025
Copy link
Contributor

Copilot AI left a 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_properties with context in 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_properties to context_and_event_properties to match the updated file path.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants