Something BIG is happening to our documentation! Check back in early October!

Platform Administrative Features

Dashboard Access

Braze manages a number of different instances for our Dashboard and REST Endpoints. When your account is provisioned you will log in to one of the corresponding URLs below. Please feel free to bookmark these as you continue through the platform. If you are unsure, open a support ticket or use the table below.

Instance Dashboard URL
Braze 01
Braze 02
Braze 03
Braze EU

Software Development Kit (SDK) File Sizes

A Software Development Kit (SDK) is a set of tools that can be used to develop software applications targeting a specific platform. Learn more about the Braze SDK in our LAB course, Braze 101.

Platform SDK Size
Android 763 KB
iOS 1.16 MB
Web 32.3 KB

App Group Management

You can manage, segment, and communicate with multiple applications simultaneously all from the Manage App Group tab in your navigation pane.


App groups are designed to house versions of the same application across multiple platforms. Many clients also use app groups to contain free and premium versions of their application on the same platform.

Renaming or Deleting Your App Group

Click the pencil on the “App Settings” page to rename your app group. The name of your app group controls the title that will be displayed for iOS push notifications.

Delete your App Group entirely from the Dashboard by clicking the Settings Icon on your Manage App Group Page and selecting “Delete App Group”.

Click on the gear-shaped Settings icon and select “Delete App Group” from the drop down to delete your app group entirely from the Dashboard.


Custom Event and Attribute Management

Adding Custom Attributes, Custom Events, Products, and Event Properties

To add a custom attribute, event, or product, go to the Custom Attributes, Custom Events, or Products pages, respectively, under “Manage App Groups” by clicking the “Add ..” button on the upper right hand corner of the lists of data. This will enable tracking on it.


You can also add event properties for custom events or products by clicking on the “Manage Properties” link in the “Event Properties” column:

customeventsview1.png manageproperties1.png

To make these added custom attributes, events, products, or event properties trackable, you must ask your developer to create it in the SDK using the exact name you used to add it earlier. Or, you may use Braze’s APIs to import data on that attribute. After that, the custom attribute, event, or other will be actionable and apply to your users!

Blacklisting Custom Attributes, Custom Events, and Products

If you want to stop tracking a specific custom attribute/custom event/product (e.g., accidental creation during testing, no longer useful), search for it in the Custom Events tab, then click Blacklist.


Once a custom event or attribute is blacklisted, - No data will be collected regarding that event/attribute, - Existing data will not be wiped, - Blacklisted events/attributes will not show up in filters or graphs.

Changes to the blacklist may take a few minutes to propagate. You may re-enable any blacklisted event or attribute at anytime.

Please note that you should still remove the event/attribute from your app code during your next release.

Forcing Data Type Comparisons

Braze automatically recognizes data types for attribute data that is sent to us. However, in the event multiple data types are applied to a single attribute, you can force the data type of any attribute to let us know what it really is. Click on the dropdown in the Data Type column to choose.


If you elect to force the data type for an attribute, any data that comes in that isn’t the specified type will be ignored.

For more information on specific filter options exposed by different data type comparisons please see “Configuring Reporting - Braze Academy”. And for more information on the different available data types, please see the section on “Custom Attribute Data Types”.

Please note that data sent to Braze is immutable and cannot be deleted or modified once we’ve received it. However, you can use any of the steps listed above to exercise control over what you’re tracking in your dashboard.

User Account Management

Adding Users to Your Dashboard

Adding users to your dashboard is very simple: visit the Manage Users page under your username and click the Add New User button as indicated below:

Add New User1

Add New User2

Deleting Users From Your Account

Deleting users is also accomplished via the Manage Users page. To delete a user click on the trash icon pictured below.

Delete a User

User Permissions

Setting User Permissions

Braze’s user permission feature allows you to choose who can access your apps on the Braze dashboard by assigning different users with either admin (designated by a yellow crown next to your username) or limited permission. The creator of the app group will automatically be granted admin access.

User Permissions

When you create a user, they will be designated as an admin by default. To change this, click on the User Role drop down and select Limited.

Level of Access Permissions
Administrator Administrators have access to all available features.
Limited Limited users are completely customized at several levels. When you switch a user’s permissions from admin to limited, that user no longer has access to any portion of the Braze dashboard until you deem it so using the checkboxes that appear below the Edit User box.

Editing User Permissions

You can easily change a given user’s access at any time.

Edit User Permission

Individual users can be granted different degrees of access on an app-by-app basis.

Limited Permission Degree Details
Company Level Regarding managing the company’s app and group settings.
App Group Level Permissions Which App Groups should the limited user be able to manage?
App Level Settings What level of editing access should this limited user have? (See sample image below or further details here.)

Permissions App to App

There is no limit on the number of users (either admins or limited users) you can have on your dashboard. However, if there is only one admin left in your app group, that individual will not be able to remove admin permission.

Resetting Your Password

To reset your password, click the ‘Reset Password’ button on the dashboard login page. You will then be prompted to input your email to receive a link to reset your password.

Reset Password Button

Okta Single Sign On

Okta connects any person with any application on any device. It’s an enterprise-grade, identity management service, built for the cloud, but compatible with many on-premises applications. With Okta, IT can manage any employee’s access to any application or device.

Setting up Okta with Braze

Braze, acting as a service provider, has created a simple step-by-step guide to setup Okta as your Identification Provider. This will ensure all control is handled based on your companies security settings.


  • Okta must be turned on for your account. Reach out to your success manager to have this turned on.
  • You must have admin privileges for both Okta and Braze.

Step 1

Login to Okta. Click Add Applications.


Step 2

Find the Braze app.


Step 3

Enter the appropriate domain based on your cluster.

Instance Dashboard URL
Braze 01
Braze 02
Braze 03
Braze EU


Step 4

Select SAML as your sign on option.


Click View Setup Instructions and copy the target URL and certificate that is generated.

Step 5

Setup the Braze Dashboard.

  • Log on to Braze Dashboard using an admin account.
  • Click on the drop down from your user name in the upper right corner, select Company Settings.
  • Select the Security Settings tab.
  • Turn on the Okta Single Sign-On (SSO) switch.
  • Enter the Target URL with the Embed Link from the Okta Admin Console.
  • Enter the Certificate with the Certificate you downloaded from the Okta Admin Console (open the file, copy, and paste).
  • Click Save Changes at the bottom of the page.


Step 6

Back on the Okta Admin page, you can now assign people or groups to the Braze app.


Optional: Okta-Only Log In

Go to Company Settings on the Braze app, then the Security Settings tab to utilize Restrict Single Sign-On(SSO) and force all users to log in via Okta only. This will prevent users from logging in via password. Leaving this unchecked will allow your users to login via Okta or their password. This method can be used to help test when first implementing Okta.


Braze Admins can divide subsets of their Dashboard users into Teams with varying user roles and permissions. Teams can be set up across customer base location, language, and custom attributes such that members and non-members have different access to messaging features and customer data. With Teams, Braze Admins have the ability to organize Dashboard users within varied corporate structures.

Teams is not available on all Braze contracts. If you’d like to access this feature, reach out to your account executive and customer success manager or contact us at for a consultation.

Adding a New Team

A Team is a specific subset of your user base, that is determined by either a country, language, or custom attribute filter. Once created, you’ll be able to restrict access to your Braze users and permit or deny them the ability to perform different actions to users who belong in certain Teams.

To create a Team first go to the “Manage App Group Page” and click “Manage Teams.” From there you will see an option to “+Add Team” that then populates a modal window. Here you will not only give the Team a name, but also have the option to use a Custom Attribute, Country, or Language to further define the access that will be granted.


User Roles

Teams introduces a new user Role to the Dashboard. Braze Admins can assign Team Roles to their Dashboard users, who are limited to only read/write data available to their particular Teams. Predefined Team Roles include language and location (by Countries and Regions).


The permissions available to users with Limited and Team Roles include:

Permission Per Listed App (Limited User) or Team
Full Admin
Access Campaigns, Canvases, Cards, Segments, Media Library
Send Campaigns, Canvases
Publish Cards
Edit Segments
Export User Data
View User Profiles
Manage Dashboard Users
Manage Media Library
View Usage Data
Import User Data
View Billing Details
Access Dev Console
Manage External Integrations
Manage Apps
Manage Teams
Manage Events, Attributes, Purchases
Manage Tags
Manage Email Settings
Manage Feedback

Tags and Filters

Dashboard objects can be organized by Teams. Canvases, Campaigns, Cards, Segments, email templates, and media library assets can be labeled with a Team Tag. Similarly, a Team Filter can also be used to search for the following objects: Canvases, Campaigns, Cards, and Segments.

Company Wide Settings Management

Company Settings Page

The Company Settings Page allows you to change the name of your company, set your timezone and request to delete your company. Note that only Admins and users with explicit permissions to manage Company Settings will see this page.

Consequences of Switching your Time Zone

If you choose to switch your time zone, you may face a variety of consequences:

  • While campaigns scheduled for specific times in specific locations (i.e. 9pm Eastern Time) will run properly on schedule until edited, both campaign analytics and future campaign schedules will be affected by the change.
  • Any card scheduling that is not assigned to Local Time may be affected, with active cards potentially appearing as finished (or vice versa).
  • Segmentation filters of the form “Has done X before/after Date” will have the time adjusted because the initial date will now be localized in Pacific Time.

Notification Preferences

The Notification Preferences Page is where you can configure who (if anyone) receives notifications about your company. You can configure who should recieve notifications regarding campaign and News Feed Card delivery, technical errors. You can also specify recipients for the weekly analytics report. For most notifications, Braze supports email and webhook channels.


The available notifications are in the table below:

Notification Description Webhook Support
AWS Credential Errors Notifies recipients when Braze receives an error while attempting to use your Amazon Web Services credentials for a data export. Yes
Scheduled Campaign Sent/Not Sent Notifies recipients when scheduled campaigns begin sending or when scheduled campaigns attempted to send, but had no eligible users to send to. Yes
Scheduled Campaign Limit Met Notifies recipients when a scheduled recurring campaign is not sent because the total campaign limit has been met. Yes
Scheduled Campaign Finished Sending Notifies recipients when a scheduled campaign has finished sending. Yes
Webhook Timeouts Notifies recipients when a webhook URL times out more than 300 times in 5 minutes. This notification sends no more than once every two hours. Yes
Push Credential Errors Notifies recipients when an app’s push credentials are invalid and when an app’s push credentials are expiring soon. Yes
Connected Content Timeouts Notifies recipients when a Connected Content URL times out more than 300 times in 5 minutes. This notification sends no more than once every two hours. Yes
Newsfeed Card Published/Live Notifies recipients when Newsfeed cards are scheduled or published. Yes
Weekly Analytics Report Sends a summary of the past week’s app group activity to recipients every Monday. Recipients receive a summary for each app group that they belong to. No

Slack Incoming Webhook Integration

Slack has an incoming webhook app that allows messages to be posted from external sources into Slack. To get started, open the incoming webhook app.

  • Click “Add Configuration”


  • Select the Slack channel that you’d like the notifications to go to

  • Slack will generate a URL that you’ll need to enter this URL into the settings for the notifications that you wish to receive


  • Navigate to the Notification Preferences page in Company Settings

  • Click into the notification that you wish to enable for Slack. Or, if you have multiple notifications that you want to send to this Slack Channel, you can use our “Bulk Add” feature to add the webhook to multiple notifications


  • Enter the URL that Slack generated for you

That’s it! You should start receiving notifications about your company to this Slack Channel!

Weekly Analytics Reporting

Braze optionally sends a weekly report via email to individuals you designate within your company every Monday at 5AM EST. The custom events to be included in the weekly report are selected on the Custom Events Management Tab within the “Manage App Group” page of the dashboard. You may select up to 5 events to be included in your weekly report:

Analytics Report Event Selection

Additional Email Settings

You also can access the App Settings - Email Tab to edit:

  • The name which will be displayed by default on your emails
  • The default reply-to address for your emails
  • Your custom unsubscribe page
    • If you do not provide a custom unsubscribe page Braze will handle unsubscribes automatically

email settings

List-Unsubscribe Settings


Although most marketers add a one-click Unsubscribe link to their email, it is best practice to provide a special email header (“List-Unsubscribe”) that allows email service providers such as Gmail and Windows Live Hotmail to provide their own Unsubscribe functionality:


More technical information is available here.

Benefits of the List-Unsubscribe Header

Some recipients prefer to have an Unsubscribe link available in the same place for all emails, rather than having to find links in each mailing. When enabled, this feature puts a prominent Unsubscribe link in the header of the email client, making it easier to unsubscribe and therefore less likely that customers will mark your email as Spam. This has a significant impact on your reputation and deliverability as an email sender.

How the List-Unsubscribe Header Works

Navigate to ‘Email Settings’ within your AppGroup.

Set List-Unsubscribe to ‘ON’ list_unsub_3

This feature only applies to emails that target users who are “subscribed or opted in” or “opted-in only.”

The header is not added for messages targeting “all users including unsubscribed users,” as these represent transactional messages which do not need an unsubscribe function.

This feature is not supported for Mailjet customers who are in our EU data-center

Currently ‘Windows Live Hotmail’ and ‘Gmail’ support this feature

Security Settings

The security settings page is where you can configure authentication rules, dashboard IP whitelisting, and two-factor authentication. These settings are located in the “Security Settings” tab of the Company Settings page.

Security Settings

Authentication Rules

Company administrators can configure authentication requirements for signing into Braze including setting password requirements (minimum password length, password complexity, password expiration), and enforcing Google authentication. If the company administrator decides to set password authentication rules to become more strict, as soon as these rules are set, account users will be informed by email to change their passwords accordingly.

Authentication Rules

Dashboard IP Whitelisting

Your team can add a whitelist of specific IP addresses, ranges and subnets from which users can log in to your company’s Braze account.

To mark specific IP addresses and subnets as whitelisted, fill in the IP addresses and subnets to whitelist and press Save Changes at the bottom of the page. IP ranges and subnets should be specified in CIDR (Classless Inter-Domain Routing) notation. For example, whitelisting 63.45.134.* would be expressed in CIDR notation as

For more information on CIDR notation see RFC 4632.

Dashboard IP Whitelisting

Two-Factor Authentication

Two-factor authentication adds an extra layer of identity verification upon login. By enabling two-factor authentication, Braze will require two methods of verification to log in to your Braze account: your password and your mobile phone. Braze uses Authy, a two-factor authentication service, to help secure your account.

If you would like to enforce two-factor authentication for the whole company, turn on two-factor authentication under the Security Settings tab and press Save Changes at the bottom of the page.

Two-Factor Authentication - Company Settings

When your company enforces two-factor authentication, account users must set up two-factor authentication on their own account upon log in or else they will be locked out. Account users can also go to their account settings page to enable it. There is an option to change your mobile phone number in case an account user would like to authenticate using a different mobile phone number. In addition, if two-factor authentication is optional for your company under Security Settings, account users will have the option to disable two-factor authentication. If you have any trouble enabling/verifying with two-factor authentication, please contact your account administrator or email

Under the Manage Users page, there will be an additional column that indicates which account users have turned on two-factor authentication.

Two-Factor Authentication - Manage Users

Third Party Liability

Braze or third parties may refer to third party products or functionality within the Braze online Academy. Any use by a customer of such third party services or functionality, and any exchange of data between a customer and such third party, is solely between that customer and that third party. Braze does not warrant any third party services or functionality and shall have no liability in connection with a customer’s use thereof.