Alert Type

Definition

Important

Includes essential information that should be addressed by the reader, such as:

• Deprecated features
• Impacts on billing
• Information pertaining to relevant updates
• Pressing feature caveats (ex: beta features)
• Other important tidbits of information

Note

Includes one-off information that the reader should know, such as:

• Feature caveats
• Formatting guidance
• Helpful callouts
• Information that is demoted from an Important alert due to the alert’s content dropping in severity (ex: a long-standing important alert shifting to a standard note)

Tip

Includes supplementary knowledge and recommendations for the reader to be aware of, such as:

• Additional troubleshooting articles
• Steps and shortcuts that help increase usability (ex: additional customization for in-app messages)

Warning

Includes essential information that must be addressed by the reader and can include:

• Irreversible consequences (ex: Campaign and Canvas deletion)
• Feature-breaking behavior
• Loss of data
• Other crucial warnings

Guideline

Example

Explain the information in the alert in a clear, concise statement.

Note alert in Step 4: Add Filters to Your Segment Section

For alerts that apply to different sections of the same article, consider creating a new section that captures these details to avoid repetitive content.

Property Details header in Push Send Events Section

Separate the information into short paragraphs or lists within the alert.

Important alert in Canvas Persistent Entry Properties

Consider any additional formatting that may impact how the alert displays (code snippets, steps, surrounding images, etc.).

Important alert in Step 2: Add Code Snippet to Email Body

Include a line break for alerts that begin an article.

Content Card Implementation Guide

When writing about beta features, include an Important alert that calls out the beta status and related Braze contact information.

Place this beta alert after the overview text and before the first main heading.

Canvas Persistent Entry Properties 

Avoid using two or more alerts in a row if possible.

Instead, reorganize or include the information as part of the text instead.

Setting User IDs

If you find your alert is lengthy, consider creating a new section that includes the information as a list.

For example, instead of including troubleshooting steps in an alert, consider creating a troubleshooting section or providing a link to a related article.

Tip alert in Canvas and Campaign Tag Differences Section

Article: Push for Web

Use Case

• Includes essential feature caveat that the reader should know as they set up their web push

Alert Reasoning

Use an Important alert as opposed to a Note alert because the content’s importance is greater for a reader to know as they set up their web push.

Article: Email Settings

Use Case

• Provides important feature caveat about the possibility of doubling billable emails
• Redirects reader to contact their Customer Success Manager as needed

Alert Reasoning

The Important alert is used here to communicate details about the BCC addresses in their email settings.

This information is best presented using an Important alert as opposed to a Warning alert because omitting this information does not impact the feature irreversibly (feature breaking, permanent data loss, etc.)

Article: Advanced Settings

Use Case

• Includes pressing feature caveat about the Notification Priority
• Redirects the reader to new information that’s available

Alert Reasoning

The Important alert is best used here to redirect the reader to current information and to highlight that the section is applicable only to certain users.

It’s also placed after the section header, which forces the user to address the important alert before reading the rest of the section.

Article: Create a Content Card

Use Case

• Includes additional information that a reader should be aware of as they learn more about Content Cards

Alert Reasoning

This Note alert provides background information on how Braze cycles older Content Cards for users.

This is helpful, supplemental information for the reader to be aware of and does not require the use of an Important or Tip alert.

Article: Custom Attributes

Use Case

• Includes general information that a reader should be aware of
• Provides an article to learn more about related content (time attributes)

Alert Reasoning

This information is best relayed using a Note alert as opposed to an Important alert because the content is directed to provide general information. Disregarding this information would not impact the ease of use for this feature.

Article: Custom Events and Attribute Management

Use Case

• Includes general information that a reader should be aware of
• Redirects to Braze contact for further information

Alert Reasoning

This Note alert provides additional information about data storage that would be helpful for a reader to know as they manage their custom attributes.

However, the content does not require a stronger indication of importance to the reader, so a Note alert is acceptable here.

Article: SMS Message Segments and Copy Limits

Use Case

• Includes tool for the reader to understand their message length and SMS segment count
• Provides information that may be helpful for the reader in their understanding of copy limits

Alert Reasoning

This is a lengthy Tip alert because it provides a space for entering the copy to see how many segments a message will dispatch.

The Tip alert is the best option here because this is a helpful generator for the reader to use in the process of setting up their SMS messages.

Article: Daily App Uninstalls by Date Endpoint

Use Case

• Provides troubleshooting advice when using this endpoint

Alert Reasoning

The Tip alert provides additional support for the reader.

Use a Tip alert as opposed to a Note alert because the focus of the content is to assist the reader by providing the troubleshooting article.

Article: User Profile Lifecycle

Use Case

• Indicates something that the reader should not do when creating their user profiles in Braze

Alert Reasoning

The Warning alert is used to caution the reader against assigning an external_id before uniquely identifying them.

This information is best relayed using a Warning alert as opposed to an Important alert because it includes irreversible consequences for the user profile.

Article: Segments for Currents

Use Case

• Cautions the reader when creating Currents connectors
• Includes the consequence of incorrectly creating these connectors

Alert Reasoning

The Warning alert is best used here to describe the limitations of the Braze Segment Currents integration.

Use a Warning alert as opposed to an Important alert because creating more than one of the same Currents connectors incorrectly may result in losing data.

Article: Creating a Canvas

Use Case

• Lists the information that may cause the feature to not work
• Details how the intended audience may not receive the campaign or enter the Canvas

Alert Reasoning

The Warning alert is used here to note how the feature may work incorrectly.

This information is best relayed using a Warning alert as opposed to an Important alert because the information is critical and may result in breaking the Canvas delivery.