Braze
Send user data to Braze for engagement campaigns. Sync user attributes, custom events, purchases, and more from your warehouse to Braze.
Prerequisites
- A Braze account
- A Braze REST API key with the necessary permissions
- Your Braze REST endpoint (cluster URL)
Authentication
Braze uses REST API Key authentication.
- In Braze, go to Settings > API Keys
- Create a new REST API key with the required permissions (users.track, users.delete, etc.)
- Copy the API key
- Paste it into the REST API Key field in Zeotap
Configuration
| Field | Type | Required | Description |
|---|---|---|---|
| REST Endpoint | Select | Yes | Your Braze REST API endpoint for your cluster. Suggestions cover US-01 through US-08 (Braze has no US-09), US-10, EU-01, EU-02, and AU-01. If Braze put you on a cluster that is not listed, choose Enter a custom value and paste the endpoint from Settings → APIs and Identifiers. |
| App Group ID | Text | No | Braze app group identifier (optional) |
Target Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Object Type | Select | Yes | The type of data to send: User Attributes, Custom Events, Purchases, User Delete, User Alias, User Merge, Subscription Status, Catalog Items, Trigger Campaign, or Trigger Canvas |
| Catalog Name | Text | Conditional | Catalog name (required for Catalog Items) |
| Campaign ID | Text | Conditional | Campaign ID to trigger (required for Trigger Campaign) |
| Canvas ID | Text | Conditional | Canvas ID to trigger (required for Trigger Canvas) |
| Subscription Group ID | Text | Conditional | Subscription group ID (required for Subscription Status) |
Supported Operations
Sync Modes: Upsert, Insert
Audience Sync Modes: Add, Remove, Mirror, Upsert
Features
- Field Mapping: Yes
- Schema Introspection: No
Required Mapping Fields
Required fields depend on the selected Object Type:
| Object Type | Required Fields |
|---|---|
| User Attributes | external_id |
| Custom Events | external_id, name, time |
| Purchases | external_id, product_id, currency, price |
| User Delete | external_id |
| User Alias | external_id, alias_name, alias_label |
| User Merge | identifier_to_merge, identifier_to_keep |
| Subscription Status | external_id, subscription_state |
| Catalog Items | id |
| Trigger Campaign | external_user_id |
| Trigger Canvas | external_user_id |
Default Destination Fields (User Attributes)
external_id, email, first_name, last_name, phone, gender, dob, country, city, language, time_zone, email_subscribe, push_subscribe
Realtime syncs
A Braze destination can also receive a realtime sync from a realtime audience: one person at a time, within seconds of the event that changed their answer, rather than a list on a schedule. The same destination — REST endpoint and API key — serves both.
Because Braze segments are filters rather than lists, a realtime sync represents the audience as a custom attribute on the person (true when they join, false when they leave), optionally with a custom event each time. Build your segment as attribute is true, or trigger a campaign on the event. The person is matched by external_id, which is the audience’s destination key. Settings and the full behaviour are under Realtime Syncs → Braze.
Troubleshooting
Authentication failed: invalid API key
Verify your REST API key in Braze Settings > API Keys. Ensure the key has the required permissions for the selected object type.
Incorrect REST endpoint
Each Braze cluster has a different REST endpoint. Select the endpoint that matches your Braze dashboard URL. For example, if your dashboard is at dashboard-01.braze.com, use US-01.
The dropdown is a suggestion list, not a closed set — Braze provisions new clusters from time to time. If yours is missing, pick Enter a custom value and paste the REST endpoint exactly as it appears on the APIs and Identifiers page. It must be a base URL with a scheme and no path (https://rest.iad-07.braze.com, not rest.iad-07.braze.com or https://rest.iad-07.braze.com/users/track).
External ID not found
Braze requires an external_id for most operations. Ensure your model includes a column that maps to the user’s external ID in Braze.
Rate limiting
Braze enforces rate limits on API endpoints. Zeotap batches requests and handles rate limiting automatically.