This article describes how to set up the Braze connector in your Customer Data Hub account.

In this article:

Table of Contents Placeholder

Connector Actions

Action Name AudienceStream EventStream
Track User
Delete User

Consent Categories

  • Analytics
  • Mobile
  • Personalization

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

  • API Endpoint
    • Required.
    • Select API endpoint for the instance your account is provisioned to.
    • For more information, see API Endpoints.
  • API Key
    • Required.
    • Provide API key with "users.track" and "users.delete" permissions enabled.
    • For more information, see App Group REST API Keys.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Track User

Parameters

Parameter Description
External ID
  • External ID of the user to delete.
  • When multiple IDs are specified, the first non-blank values is selected based on the following priority order:
    • External ID
    • Braze ID
    • Alias Name
    • Alias Label
  • When importing Push Tokens, External ID and Braze ID should not be specified.
  • For more information, see User Track.
Braze ID
  • Braze ID of the user to delete.
  • When multiple IDs are specified, the first non-blank values is selected based on the following priority order:
    • External ID
    • Braze ID
    • Alias Name
    • Alias Label
  • When importing Push Tokens, External ID and Braze ID should not be specified.
  • For more information, see User Track.
User Alias Name
  • The alias name of the user to be tracked.
  • When specifying a user alias, Alias Name and Alias Label should both be set.
  • For more information, see User Track.
User Alias Label
  • The alias label of the user to be tracked.
  • When specifying a user alias, Alias Name and Alias Label should both be set.
  • For more information, see User Track.
Country
  • The country of the user to be tracked.
Current Location - Latitude
  • The current latitude for the user to be tracked.
Current Location - Longitude
  • The current longitude for the user to be tracked.
Date of First Session
  • The date of the first session of the user to be tracked.
Date of Last Session
  • The date of the last session of the user to be tracked.
Date of Birth
  • The date of birth for the user to be tracked.
Email Address
  • The email address for the user to be tracked.
Email Subscription Status
  • The email subscription status for the user to be tracked.
Facebook
  • The Facebook account for the user to be tracked.
First Name
  • The first name of the user to be tracked.
Gender
  • The gender of the user to be tracked.
  • Values are Male (m) or Female (f).
Home City
  • The home city for the user to be tracked.
Image URL
  • Optional
  • The URL for the user's image.
Language
  • The language preference of the user to be tracked.
Last Name
  • The last name of the user to be tracked.
Marked Email As Spam At
  • User marked email as spam.
Phone Number
  • The telephone number of the user to be tracked.
Push Subscription Status
  • The Push Subscription status of the user to be tracked.
Push Tokens ID Array
  • Array.
  • The Push Token ID for the user to be tracked.
Push Tokens Array
  • Push tokens array.
Push Tokens Device ID Array
  • The Push Token Device ID for the user's device.
Time Zone
  • The time zone for the user to be tracked.
Twitter
  • The Twitter account for the user to be tracked.
Update Existing Only (Users)
  • Optional
  • Values are true or false.
  • If no user value exists, one will be created by default.
  • If set to true, only existing users are updated and no new users are created.
Modify User Attributes
  • Integer attributes may be incremented by positive or negative integers.
  • Array attributes may be modified by adding or removing values from existing arrays.
App ID
  • The User App ID to be tracked.
Name
  • The application name to be tracked.
Time
  • Time
Update Existing Only (Events)
  • Optional
  • Values are true or false.
  • If no event value exists, one will be created by default.
  • If set to true, only existing events are updated and no new events are created.
App ID
  • The Event Application ID to be tracked.
Product ID
  • Required for every mapped purchase.
Currency
  • Required for every mapped purchase.
Price
  • Required for every mapped purchase.
Quantity
  • Map Array type attributes to add multiple purchase items.
  • Array type attributes must be of equal length.
Purchase Time
  • Time of purchase.
  • Automatically set to "now" unless explicitly mapped.
Update Existing Only (Purchases)
  • Optional
  • Values are true or false.
  • If no purchase value exists, one will be created by default.
  • If set to true, only existing purchases are updated and no new purchases are created.

Action - Delete User

Parameters

Parameter Description
External ID
  • External ID of the user to delete.
  • When multiple IDs are specified, the first non-blank values is selected based on the following priority order:
    • External ID
    • Braze ID
    • Alias Name
    • Alias Label
  • For more information, see User Delete Endpoint.
Braze ID
  • Braze ID of the user to delete.
  • When multiple IDs are specified, the first non-blank values is selected based on the following priority order:
    • External ID
    • Braze ID
    • Alias Name
    • Alias Label
  • Must include either External ID or Braze ID.
User Alias Name
  • The alias name of the user to be deleted.
  • When specifying a user alias, Alias Name and Alias Label should both be set.
  • For more information, see User Delete Endpoint.
User Alias Label
  • The alias label of the user to be deleted.
  • When specifying a user alias, Alias Name and Alias Label should both be set.
Version history
Revision #:
10 of 11
Last update:
Friday
Updated by: