Context

Context steps allow you to create and update one or more variables for a user as they move through a Canvas. For example, if you have a Canvas that manages seasonal discounts, you can use a context variable to store a different discount code each time a user enters the Canvas.

How it works

A context variable is a temporary piece of custom data that exists only during a user’s journey through that specific Canvas. It does not persist across different Canvases or outside the journey where it is created.

Each Context step can define multiple context variables, providing a flexible way to personalize delays, segment users dynamically, and enrich messaging without permanently changing a user’s profile data.

For example, if you’re managing flight bookings, you could create a context variable for each user’s scheduled flight time. You could then set delays relative to each user’s flight time and send personalized reminders from the same Canvas.

You can set context variables in two ways:

• At Canvas entry: When users enter a Canvas, data from the event or API trigger can automatically populate context variables.
• In a Context step: You can define or update context variables manually inside the Canvas by adding a Context step.

Each context variable includes:

• A name (such as flight_time or subscription_renewal_date)
• A data type (such as number, string, time, or array)
• A value you assign using Liquid or through the Add Personalization tool.

When defined, you can use a context variable throughout the Canvas by referencing it in this format: {{context.${example_variable_name}}}.

For example, {{context.${flight_time}}} could return the user’s scheduled flight time.

Each time a user enters the Canvas—even if they have entered it before—the context variables will be redefined based on the latest entry data and Canvas setup. This allows journeys to stay personalized and accurate, even for users with multiple entries.

Creating a Context step

Step 1: Add a step

Add a step to your Canvas, then drag and drop the component from the sidebar, or select the plus button and select Context.

Step 2: Define the variables

To define a context variable:

1. Give your context variable a name.
2. Select a data type.
3. Write a Liquid expression manually or use Add Personalization to create a Liquid snippet from pre-existing attributes.
4. Select Preview to check the value of your context variable.
5. (Optional) To additional variables, select Add Context variable and repeat steps 1–4.
6. When you’re finished, select Done.

Now you can use your context variable anywhere you use Liquid, such as in Message and User Update steps, by selecting Add Personalization. For a full walkthrough, see Using context variables.

Step 3: Test exit criteria (optional)

If the context variables are valid, you can reference the variables throughout your Canvas. However, your users can exit the steps in a user journey after a Context step for the following reasons:

• The context variable doesn’t return any value (is null).
• A call to an embedded Connected Content fails.
• The context variable types don’t match.

We recommend testing and previewing your user paths to make sure your messages are sent to the right audience.

Context variable data types

Context variables that are created or updated in the step can be assigned the following data types.

Using context variables

For example, let’s say you want to send your users personalized recommendations about discounts for cosmetic products in your retail brand. These users will enter the Canvas if they haven’t made a purchase yet. The first step of the user journey will be a Delay step for one day to allow time for users to consider their purchase.

To provide these recommendations based on their preferences, we’ll create two context variables in the Context step to reference in the subsequent steps of the user journey:

• favorite_category
• discount_code

Next, we’ll set up a Message step for push notifications that includes the discount code for their favorite product category. The Liquid snippets for the context variables will be:

• {{context.${discount_code} | default: 'SPRING10'}}
• {{context.${favorite_category} | default: 'sitewide'}}

Based on the user’s favorite category, they’ll receive an exclusive discount code to use.

Converting strings to JSON

For consistency and error prevention, JSON returned by a Connected Content call will be evaluated as a string data type. If you want to convert this string into JSON, convert it by using as_json_string. For example:

1
2
{% connected_content http://example.com :save product %}
{{ product | as_json_string }}

Troubleshooting

Mismatched data types

If the Liquid expression at runtime returns a value that doesn’t match the data type, the context variable won’t be updated. For example, if the data type is set to Number but the value returns a string, the following will occur:

• The user will either advance to the next step or exit if it’s the last step in the Canvas.
• The Canvas step analytics will count this as Not Updated.

Refer to Context variable data types for the example setups for each data type.

Frequently asked questions

How do context variables differ from Canvas entry properties?

If you’re participating in the Context step early access, Canvas entry properties are now part of Canvas context variables, meaning canvas_entry_properties is now referenced as context. This also means you can send Canvas entry properties using the Braze API and reference them in other steps, similar to using a context variable with the Liquid snippet.

Can variables reference each other in a singular Context step?

Yes. All variables in a Context step are evaluated in a sequence, meaning you could have the following context variables setup:

In a Message step, you could use the Liquid snippet {{context.${personalized_message}}} to reference the context variable to deliver a personalized message to each user.

This also applies to multiple Context steps. For example, if Context step A defines Variable A as job_title, and Message step A uses Variable A, then Context step C updates Variable A to be job_description, then all subsequent steps referencing Variable A will have the value of job_description.