> ## Documentation Index
> Fetch the complete documentation index at: https://docs.subtotal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Connect Braze and configure how customers are identified.

## Overview

Our integration with [Braze](https://braze.com) enables brands to deliver real-time retail purchase data as custom events, powering personalized messaging campaigns and customer journeys.

This integration makes it easy to:

* Trigger campaigns and Canvases based on verified retail purchases
* Engage customers when they link or unlink retail accounts
* Re-engage customers when their credentials expire with reconnection prompts

Connect your Braze account to get started.

## Prerequisites

You'll need a Braze REST API key with the **`users.track`** permission.

<Steps>
  <Step title="Create a REST API key in Braze">
    In your Braze dashboard, navigate to **Settings > APIs and Identifiers**. Click **Create New API Key**, give it a descriptive name (e.g. "Subtotal Integration"), and enable the **`users.track`** permission under the User Data section.
  </Step>

  <Step title="Find your Braze instance">
    Your Braze instance determines the regional API endpoint. You can identify it from your Braze dashboard URL. For example, if your dashboard URL is `dashboard-01.braze.com`, your instance is **US-01**.
  </Step>
</Steps>

## Connect your Braze account

Sign in to the Subtotal Dashboard and connect your Braze account to enable the integration.

<Steps>
  <Step title="Navigate to Braze integration">
    Go to [*Integrations > Braze > Connect*](https://dashboard.subtotal.com/integrations/braze) in the Subtotal Dashboard.
  </Step>

  <Step title="Enter your API key">
    Paste the Braze REST API key you created above.
  </Step>

  <Step title="Select your Braze instance">
    Choose the regional instance that matches your Braze dashboard (e.g. US-01, EU-01).
  </Step>

  <Step title="Choose a customer identifier type">
    Select how Subtotal should match your customers to Braze user profiles.
  </Step>
</Steps>

You should now see an `Active` status on the Braze integration page.

## Configuration

After connecting, you can adjust the integration settings.

| Setting                      | Description                                                                                                                                                                |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **API Key**                  | Braze REST API key. Must have the `users.track` permission enabled.                                                                                                        |
| **Braze Instance**           | Regional API endpoint for your Braze account. Supported instances: US-01 through US-08, US-10, EU-01, EU-02, AU-01, ID-01, JP-01. Find this from your Braze dashboard URL. |
| **Customer Identifier Type** | How Subtotal matches customers to Braze user profiles: **Email** (email address), **Customer ID** (mapped to Braze `external_id`), or **Mobile** (phone number).           |

<Note>
  The customer identifier type determines which field on the Subtotal connection is used to look up the corresponding Braze user profile. Make sure the identifier you choose is consistently set on your connections.
</Note>
