The Developer Console is useful for both important identification information for your app group and for troubleshooting. There are typically four tabs in this section, which might show subject to your access or permissions level: API Settings, Message Activity Log, Event User Log, and Internal Groups. Each is outlined below.
API Settings Tab
The API Settings page displays API identifications for your app group. The first section on Services will link you to our technical documentation for whatever you’re using the API for (User Data, Messaging, Email Sync, and Exporting your data).
Rest API Keys
This section provides your App Group REST API Key, the unique identifier that allows you access to your data for an app group. This key is required with every request to the Braze API.
You can whitelist specific IP addresses and subnets to send requests to our API for this app group. If you don’t specify any, requests can be sent from any IP address.
These identifiers are used to reference specific Apps in requests made to the Braze API.
Additional API Identifiers
To integrate with our API, you can search for the identifiers related to any Segment, Campaigns or Cards that you want to access from Braze’s external API. Once you’ve selected any of them, the identifier will be displayed underneath the dropdown menu.
Message Activity Log Tab
The Message Activity Log, in the Developer Console, gives you the opportunity to see any messages, especially error messages, associated with your campaigns and sends. You can see API campaign transactions, troubleshoot details on failed messages, and gather insight on how to improve notification delivery or solve existing technical issues.
These messages can come from our own system, your apps or platforms, or our third party partners. This can result in an infinite number of messages that can appear in this log.
To determine what your messages mean, pay attention to the wording of each message and the columns that correspond with it, as it can help you troubleshoot using context clues. For example, if you have a log entry whose message states “empty-cart_app” and you aren’t sure what that means, look to the left at the Type column. If you see “Aborted Message Error”, you can safely assume the message was what was written as the abort message using Liquid, and that the message was aborted because the intended recipient of the message had an empty cart in your app.
However, there are some common message types you might see, and some might even provide troubleshooting links to help you diagnose and fix issues.
||Sample Text in Message Column
||The email account that you tried to reach is disabled. Learn more at SAMPLE URL.
||Your message never reached this person’s inbox - because there was no inbox to reach! If you want to dig further in, messages like this can sometimes have links in the View Details column that will allow you to view the intended recipient’s profile.
||Spam message is rejected because of anti-spam policy. For more information, please visit SAMPLE URL.
||Uh oh. Looks like your message got categorized as spam here. It might just might be for that intended recipient, but if you’re seeing this message a lot, you might want to re-evaluate your send habits or the content of your message. Also, think back - did you do an IP warm-up? If not, reach out to Braze for advice on getting one going.
|Aborted Message Error
||If you have an app with a cart or you create a send with an abort message in the liquid, you can customize what message is returned to you if the send is aborted. In this case, the message returned is empty-cart_web.
Event User Log Tab
The Event User Log can help you break down, debug, or otherwise troubleshoot issues in your Braze Integration. This tab gives you a log of errors that details the type of error, which app it’s associate with, when it happened, and often an opportunity to view the raw data associated with it.
To find your logs easily, you can filter based on:
- SDK or API
- App Names
- Time frame
Each log is broken up into multiple sections, which can include:
- Device Attributes
- User Attributes
- Campaign Events
- Response Data
Click the “Raw Data” button to show the raw JSON data for that specific log.
Event User Logs will remain in the dashboard for 7 days after they are logged.
Internal Groups Tab
Internal Groups are a great way to build and organize internal or 3rd party test groups and provide insight into the SDK or API logs available from your test device during SDK integration testing. You can create an unlimited number of custom Internal Groups with up to 1000 members.
Creating a Group
Depending on your access and permissions, you can create Internal Groups from the Developer Console in the
- Click ‘Create Internal Group’ on the top, right to create a new group.
- Give your group a name.
- Choose a group type from those shown (defined below).
|User Event Group
||Used for verifying events or logs from your test device.
|Content Test Group
||A similar concept to Test Lists. Can be used across Push, Email, and In-App messages to send a rendered copy of the message.
||Automatically sends a copy of the Email to everyone the Seed Group upon send.
Adding Test Users
After you create your Internal Group you can add test users as members. If you are not already on your Internal Group’s management page, click into it. Then, click “Add Test User” and add them as identified or anonymous users, or in Bulk.
|Add Test User Tab Name
||Search for the user by their External User ID or email address.
||Search by IP address. Then, provide a name for each test user that is added. This is the name that all event logs will be associated with on the Event User Log page.
|Bulk Add Users
||Copy and paste a list of email addresses or external ID’s into the provided section. Braze will only allow you to add users that are already known in the database. Remember to upload your .csv files to add users to the database or programmatically create them via the API.
Content Test Groups
Similar to sending a preview test of a message, the Content Test group saves you time and allows you to launch tests to a pre-defined list of Braze Users simultaneously. This functionality is available for Push, In-App Message, and Email within Braze.
You can select individual Braze Users or as many Internal Groups to send the message to as you want. The message will utilize the attributes available for each individual User. For Users who have no attributes, the default value set will be utilized.
Additionally, if you preview the message as a ‘random user’, ‘custom user’ or ‘select an existing user’ - the option to send that previewed version is presented. Unchecking the box will allow you to send based on each Users’ attributes versus the previewed version.
Lastly, for clients who use an IP pool to send out email, you can now select which IP pool you would like the email to be sent from by simply selecting the pool from the dropdown available.
Only Groups that are tagged as Content Test will be available on the ‘preview’ section of a message.
Seed Groups are only meant for the Email channel and allow you to send a copy of each email variant message to members of that group. Seed Groups are not available for API Campaigns, though you can include Seed Groups via an API triggered entry in Campaign. This feature is typically used with partners such as Return Path or 250OK to measure deliverability metrics. It can be used to keep a record of the email content for historical/archive purposes.
Once you have created an Internal Group and tagged it to be used as a Seed Group, you can select it from the Delivery section of the Campaign composer or on the Send Settings section in a Canvas.
If your Seed Group members report not seeing the message in their inbox, ensure that they are listed in the Internal Group, verify that your subject lines are different and that Gmail has not bundled the emails together, or have them check their SPAM folders.
Seed Groups can be edited from the ‘Targeting’ page when composing an Email Campaign.
Seed Groups send to each email variant once and are delivered the first time your user receives that particular variant. For scheduled messages this typically is the first time the campaign launches. For Action-Based or API Triggered campaigns, this will the time the first user is sent a message.
If your campaign is multivariate and your variant has a 0% send percentage, it will not be sent to seed groups. Additionally, if the variant has already been sent and has not been updated to resend in Edit Seed Groups on the Target page, it will not send again by default.
If there is a recurring campaign and an update is conducted on any one of the variants, you have the option of re-sending to only the updated variants, all variants or to turn off seed group sending upon update.
Seed groups in Canvas work in a similar fashion to that of any Triggered Campaign. Braze automatically detects all steps that contain an email message and will send to these when your user first reaches that particular email step.
If an Email step was updated after the Seed Group was mailed, the option to only send to updated steps/all steps/turn off seeds will be presented.