Skip to content

User Guide
Developer Guide
API
Technology Partners
What's New

User Guide

Home
User Guide
Developer Guide
API
Technology Partners
What's New

braze.com

Press Arrow down to open the documentation menu without expanding the sidebar.

Users and segments

Campaigns and Canvases

Data dictionary

Navigation deep links

Account-based segmentation

Salesforce Sales Cloud

Access your account

Language settings

API and SDK endpoints

Braze Certification

Create and manage workspaces

Migrate data between workspaces

User management

Automated user provisioning

SCIM group role mapping

Internal groups

SAML and single sign-on

SAML Just-in-Time provisioning

Microsoft Entra SSO

Contact information

Notification preferences

Security settings

Security events export with S3

Workspace time zones

Workspace settings

APIs and identifiers

Brand guidelines

Email preferences

Bot filtering for emails

Logs and alerts

API usage alerts

Message activity log

Localization settings

Messaging rate limits

OAuth and MCP access

Credits Usage dashboard

Spam regulations

Cloud Data Ingestion

Data warehouse integrations

File storage integrations

Google Workload Identity Federation

Snowflake workload identity

Sync and delete catalog data

Sync Decisioning Studio data

Zero-copy personalization

Sync logs and observability

Delete users with CDI

Connected sources

Data Transformation

Create a transformation

Create a formula

SDK data collection

User profile lifecycle

Anonymous users

Collection use case

Collection best practices

Manage custom data

Blocklist custom data

Standard attributes

Custom attributes

Array of objects

Nested custom attributes

Custom event properties

Recommended events

Use eCommerce recommended events

Purchase events

Event naming conventions

Create a catalog

Catalog triggers

Back-in-stock notifications

Price drop notifications

Set up Currents

Available partners

Event delivery semantics

Custom Currents Export

Currents event glossary

Customer behavior and user events

Message engagement events

Currents Event Changelogs

How Braze uses Currents

Transfer data from Amazon S3 to Snowflake

Transfer data to Redshift

Export Braze data

Message archiving

Troubleshooting

Identifier field-level encryption

Data points (Legacy)

Manage audience

Merge duplicate users

Create a segment

Manage segments

Segmentation filters

Measure segment size

Segment Extensions

CDI Segment Extensions

SQL Segment Extensions

Catalog segments

SQL table reference

Calculated filters

Segment Insights

Location targeting

Regular expressions

Troubleshooting

Use case: Nested custom attributes

Locations and geofences

Location tracking

Create geofences

Subscription preferences

Subscription status

Subscription groups

Preference center

API email preference center

Drag-and-drop email preference center

Global Control Group

Conversion events

Workspace quiet hours

Delivery and entry types

Rate limiting and frequency capping

Message Prioritization

Know before you send

Multi-language messages

Right-to-left messages

Send test messages

Messaging rules

Copy across workspaces

Shareable preview

Idle campaigns and Canvases

Campaign basics

Create a campaign

Manage campaigns

Edit your campaign after launch

Campaign alerts

Search for campaigns

Schedule your campaign

Scheduled delivery

Action-based delivery

Attribute triggers

Campaign Connector

API-triggered delivery

Content calendar

API-triggered and action-based campaigns

Campaign analytics

Retention reports

Ideas and strategies

Active user campaigns

Add-to-calendar links

Automate Zoom registration

Capture lapsing users

Retargeting campaigns

Understanding user installs

Booking reminder email

Feature awareness and new app version

Create a Canvas

Comments in Canvas

Context and event properties

Persistent entry properties (legacy)

In-app messages

Canvas components

Canvas Audience Sync

Experiment Paths

Content Optimizer

Send to Destination

Manage Canvases

Edit Canvases after launch

Save drafts for Canvas

Canvas version history

Preview user paths

Send test Canvases

Canvas analytics

Retention reports

Ideas and strategies

Canvas outlines

Canvas QA checklist

Launch with Canvas Flow

eCommerce use cases

Matching exit criteria to entry events

Booking reminder email

Troubleshooting

Design and edit

Dashboard tools

Preview personalization

Campaign and Canvas attributes across sources

Canvas entry properties

Key-value pairs

Promotion codes

Migrate from Data Feeds

Context variables

Action and media URLs

Liquid reference

Supported personalization tags

Advanced filters

Message extras tag

Set default values

Conditional messaging logic

Liquid use case library

Connected Content reference

Make a Connected Content call

Local Connected Content variables

Abort Connected Content

Cache responses

Pull user profile data

Connected Content Debugger

Troubleshoot webhooks and Connected Content

Connected Content retries

Use public APIs

Image specifications

Manage templates

Canvas templates

Use Braze templates

Abandoned intent

Email sign-up with double opt-in

Feature adoption

Onboarding with preferences survey

Post-purchase feedback

Email templates

Create an email template

Upload an HTML email template

In-app message templates

Create an in-app message template

Onboarding flow

SMS, RCS, and WhatsApp sign-up form

Email sign-up form

Email sign-up with discount

Email sign-up with image

Email sign-up with offer

Email sign-up with confirmation

Product announcement

Seasonal promotion with image

Webhook templates

Variant distribution

Random bucket numbers

Conversion correlation

Race conditions

Create feature flags

Feature flags in Canvas

Feature flag experiments

Create landing pages

Multi-step forms

Customize the URL

Personalize landing pages

JavaScript bridge

Manage Subscriptions block

Create custom form blocks

About tracking data

Create a Banner

Custom code and JavaScript bridge

Create a Content Card

Creative details

Improve low latency

Know before you send

Set up IPs and domains

Email self-serve

Verified domains

Amazon SES setup

Understanding DNS records

Automated IP warming

Email authentication

Email validation

Import your email list

Troubleshooting

Consent and address collection

Deliverability pitfalls and spam traps

Open pixel and click tracking

Drag-and-drop editor

Gmail Promotions tab

Troubleshooting

Email global style settings

Universal links and App Links

Custom email footer

Email analytics glossary

Email deliverability glossary

Email guidelines

Email deliverability

Send emails to Apple Private Relay

Apple Mail Privacy Protection

Sunset policies

Know before you send

Set up KakaoTalk

Create a KakaoTalk message

KakaoTalk reporting

KakaoTalk click tracking

Transactional email

Create a transactional email

Set up tracking

In-app messages

Drag-and-drop editor

Create an in-app message

Email capture form

Dark mode themes

Video in custom HTML

In-app rating prompt for iOS

Know before you send

Create a LINE message

LINE click tracking

User management

Subscription groups

Push token lifecycle

Push subscription states

Create a push message

Message and image formats

Push action buttons

Multiple platform push messages

Platform-specific resources

Android options

Notification options

Create rich notifications

Notification channels

Advanced push campaign settings

Notification options

Create rich notifications

Custom app icon feature (iOS 10.3)

Utilizing badge count

Troubleshooting

Push primer in-app messages

Deliverability for Chinese Android devices

Know before you send

Common push error messages

SMS, MMS, and RCS

10DLC application

User phone numbers

Subscription groups

Geographic permissions

Create a message

Features and optimization

Link shortening

Self-serve custom domains

Keyword processing

Opt-in and opt-out keywords

Custom keyword handling

Handle unknown phone numbers

User retargeting

Bot click filtering

Compliance and delivery

Laws and regulations

Collect user opt-ins

Know before you send

Preventing SMS, MMS, and RCS traffic pumping fraud

Billing calculator

Create a webhook

Use case: Create a Braze-to-Braze webhook

Embedded signup

BYO WhatsApp connector

User phone numbers

Subscription groups

Multiple business accounts

WhatsApp phone numbers

Acquire a number

Migrate a number

Transfer between workspaces

Create a WhatsApp message

Message and image formats

Message processing

Quality rating and messaging limits

Opt-ins and opt-outs

Handle unknown phone numbers

Features and optimization

Optimized delivery

Product messages

User retargeting

Usernames and BSUID

WhatsApp Template Builder

Carousel templates

Ads That Click to WhatsApp

WhatsApp and external systems

Two-way conversation

Abandoned cart reminder

Dashboards

Channel performance

Deliverability Center

Dashboard Builder

Messaging Observability

Industry Benchmarks dashboard

Campaign analytics

Canvas analytics

Segment reporting

Report Builder (legacy)

Query templates

Metrics by segments

Engagement reports

Custom events report

Retention reports

Configure reporting

Uninstall tracking

Influenced opens

Segment analytics tracking

Metrics glossary

Knowledge sources

Conversational Agents

Agentic Standards

Braze MCP server

Braze MCP server setup

Using the Braze MCP server

Available API functions

Content Optimizer

Decisioning Studio Go

Set up your agent

Composing with Canvas

Troubleshooting

Decisioning Studio Pro

Design decisioning agents

Prepare your data

General principles

Critical data assets

Snapshots versus event streams

Use Braze external ID

Connect your data

Backfilling best practices

Choose your features

Define your audience

Set up orchestration

Launch your agent

Reports and insights

Data transformation

AI SQL Generator

Intelligence Suite

Intelligent Timing

Optimize with BrazeAI

Support tickets

Data privacy and security

Troubleshooting

Predictive Suite

Predictive Churn

Create a churn prediction

Messaging users

Churn analytics

Troubleshooting

Predictive Events

Create an Event Prediction

Messaging users

Event analytics

Item recommendations

AI recommendations

Rules-based recommendations

Use recommendations

Example library

Filter by date range

Match catalog items to an attribute array

Localized catalog content

Order Placed SQL dashboards

Refresh profile data before send

Message inbox from push

Compare data ingestion options

Campaign or Canvas

Multi-channel scenarios

Eligible audiences

Multi-language scenarios

Landing page date picker

Personalized survey follow-up email

Compare translation approaches

Test messages with mock JSON

Link cross-domain Web SDK users

Press Esc to close the menu

Dashboards

Use dashboards in Braze to monitor key performance metrics, track channel engagement, and diagnose messaging issues.

Section articles

Home dashboard
Channel performance dashboard
Conversions dashboard
Deliverability Center
API usage dashboard
Dashboard Builder

Documentation for the Braze customer engagement platform.

Resources

Braze Learning
Community
Certification
Alloys

Legal

Innovation Statement
Data Retention
Data Protection
Compliance Documentation

Company

About
Careers
Blog
Contact

© 2026 Braze, Inc. All rights reserved.

Privacy Policy Terms

Checking Braze status