Braze
This page describes how to use Census with Braze.

Note on Braze API Costs

Braze prices its API on a per datapoint update basis. Census ensures that only fields that need to be updated are sent (rather than a copy of the entire record). Please be aware that large datasets, which change often can increase your Braze API usage.

๐Ÿƒโ€โ™€๏ธ Getting Started

In this guide, we will show you how to connect Braze to Census and create your first sync.

Prerequisites

1. Create a Braze API key

Braze lets you create a number of API keys, each with their own set of permissions. You'll almost certainly want to create a new API key for Census rather than reusing an existing one.
Within Braze's left navigation bar, scroll down to the very bottom. Under App Settings and click Developer Console.
Then, inside the API Settings tab, under Rest API Keys, click + Create New API Key.
Provide a name you'll recognize ("Census" is a good choice) and select the following permissions:
  • All User Data permissions, except for users.delete
  • segments.list
  • This permission set may change as we add support for more Braze objects so you may want to grant more permissions now or plan to update these permissions in the future.
Scroll down and click Save API Key.
Finally, copy the long code you see under Identifier. We'll use that in a minute.

2. Select your Braze API Endpoint

Braze requires that we use a slightly different URL to access your account depending on where it's been set up. See the full list of all Braze API Endpoints. In general, you just need the number from the URL you see in your browser when you're signed into Braze. For example, if your Braze URL is https://dashboard-03.braze.com/, then your API Endpoint should be https://rest.iad-03.braze.com.

3. Create the Census Connection

Great! Now let's pull it all together.
  1. 1.
    In the Settings tab, Create a new Braze Service Connection in Census.
  2. 2.
    You can provide whatever name you like.
  3. 3.
    Provide the appropriate Braze Endpoint URL.
  4. 4.
    Copy and paste your new Braze API key.
    โ€‹
    โ€‹
And you're all set and ready to get syncing! ๐ŸŽ‰

๐Ÿ—„ Supported Objects

Census currently supports syncing to the following Braze objects.
Object Name
Supported?
Identifiers
User
โœ…
External User ID
Event
โœ…
Event ID
Census supports custom fields on both Braze User and Event objects. Additionally, Census supports sending structured data to Braze:
  • โ€‹User Push Tokens - To send push tokens, your data should be structured as an array of objects with 2-3 values: app_id, token, and an optional device_id.
  • Nested Custom Attributes - Both objects and arrays are supported. As of April 2022, this feature is still in early access. You may need to contact your Braze account manager for access.
โ€‹Contact us if you want Census to support more objects for Braze.

๐Ÿ”„ Supported Sync Behaviors

Learn more about all of our sync behaviors on our Core Concepts page.
Behaviors
Supported?
Objects?
Update or Create
โ€‹โœ…โ€‹
User
Mirror
โœ…
User
Append
โœ…
Event
Braze's Mirror behavior optionally supports a choice of two actions when a records is removed from the source. This can be configured when setting up the sync initially:
  • Delete record - This is the typical behavior for most mirror syncs. When a record is removed from the source, the corresponding record will be deleted from Braze.
  • Null out fields - This is a new behavior for mirror syncs in Braze. In this case, when a record is removed from the source, the currently mapped fields of the synced will be removed from the destination record (by setting them to Null).
โ€‹Contact us if you want Census to support more sync behaviors for Braze.

๐Ÿš‘ Need help connecting to Braze?

โ€‹Contact us via [email protected] or start a conversation with us via the in-app chat.