Braze

Customer engagement platform for personalised messaging across channels including push, email, in-app, and SMS.

Configuration

FieldTypeRequiredDescription
rest_api_keysecretYesYour Braze REST API key. Found in the Braze dashboard under Settings > API Keys.
app_idstringYesThe app identifier for the target app group. Found in Settings > API Keys under Identification.
rest_endpointselectYesThe Braze REST endpoint instance for your account. Check your dashboard URL to determine your cluster.
external_id_fieldstringNoThe event property to use as the Braze external_id. Defaults to ‘user_id’ if not specified.

Quick Setup

  1. Navigate to Integrations in the sidebar.
  2. Open the Integration Library tab.
  3. Find Braze or filter by CDP.
  4. Click Install, select a variant if available, and fill in the required fields.
  5. Click Install Integration to create the integration with a ready-to-use default configuration.

API Setup

curl -X POST http://localhost:8084/v1/admin/integration-catalog/braze/install \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Braze",
    "variant": "default",
    "config": {
      "rest_api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "rest_endpoint": "US-01"
    },
    "delivery_mode": "server_side"
  }'

Variants

Braze is available in multiple pre-configured variants to match your industry:

VariantDescription
DefaultStandard Braze integration for user tracking, custom events, and user attribute updates.
RetailOptimised for retail and e-commerce with purchase events, cart activity, and product interaction tracking.
MediaOptimised for media and content platforms with content engagement, watch time, and subscription event tracking.

Each variant provides a tuned default configuration. You can customise any setting after installation.

Delivery

Events are delivered server-side from your Datafly Signal infrastructure directly to the Braze API. No client-side scripts are loaded for this integration.

Visit Braze documentation for full API documentation and credential setup instructions.