Braze

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

Prerequisites

Complete these steps in Braze before configuring Signal.

Configuration

Signal Setup

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 applicable, and fill in the required fields with the credentials gathered above.
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 use case:

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

Event Mapping

Signal events are mapped to Braze API calls as follows:

The external_id is resolved from the event property specified in external_id_field (defaults to user_id). Anonymous events use the Braze anonymous ID.

Delivery

Events are delivered server-side from your Datafly Signal infrastructure directly to the Braze REST API. No client-side scripts are loaded unless you explicitly enable the SDK endpoint.

Testing

1. After installing the integration, trigger a test event from your website or via the Signal event API.
2. In Braze, navigate to Users > User Search and search by external ID or email to verify the user profile was created.
3. On the user profile, check the Custom Events tab to verify events were received and the User Profile tab for attribute updates.
4. In Signal, check the Live Events view to confirm the event was delivered with a 201 response status.

Troubleshooting