Braze

18min

Summary
Official websites
Site
URL
Website
﻿https://www.braze.com﻿
Documentation
﻿https://www.braze.com/docs﻿
Developer integrations
Platform
URL
Android
﻿https://github.com/Appboy/appboy-android-sdk﻿
iOS
﻿https://github.com/Appboy/appboy-ios-sdk﻿
Web
﻿not supported by Purple﻿
Tracking service
Event support matrix
Overview of the supported events and their configuration.
﻿
Templates
Parameter
﻿Actions﻿
﻿action﻿
﻿not supported﻿
﻿Purchases﻿*﻿
﻿none﻿
﻿not supported﻿
﻿Attributes﻿
﻿name﻿
﻿not supported﻿
﻿Views are not supported.
﻿(*) Tracking of Purchases is not supported in a freely configurable way. More detailed information can be found below in the description of the event configuration for purchases.
General structure in tracking_config.json
Tracking service key name in "tracking_config.json" is:
"appboy"
General structure
{
  
  "appboy": {
    "eventsEnabledByDefault": true,
    "viewsEnabledByDefault": false,
    "purchasesEnabledByDefault": false,
    "attributesEnabledByDefault": true,
    
    "events": {
      // your configured list of events
    },
    
    "views": {},
    
    "purchases": {},
    
    "attributes": {
      // your configured list of attributes
    } 
  
  }
  
}
{
  
  "appboy": {
    "eventsEnabledByDefault": true,
    "viewsEnabledByDefault": false,
    "purchasesEnabledByDefault": false,
    "attributesEnabledByDefault": true,
    
    "events": {
      // your configured list of events
    },
    
    "views": {},
    
    "purchases": {},
    
    "attributes": {
      // your configured list of attributes
    } 
  
  }
  
}
﻿
Event configuration
Actions
Braze supports action events. 
Action event
Example 1
Example 2
"action_event_key": {
  "templates": {
    "action": "value of template"
  }
}
"action_event_key": {
  "templates": {
    "action": "value of template"
  }
}
﻿
Views
Braze does not support view events.
Purchases
Braze does not support custom purchase events, but purchases can still be tracked and it is recommend configuring the purchase events.
Purchase event
Example
"STOREFRONT_SUBSCRIPTION_PURCHASED": {
  "templates": {}
}
"STOREFRONT_SUBSCRIPTION_PURCHASED": {
  "templates": {}
}
﻿
Templates
Braze offers a limited API to track purchases. Thus only the following data is sent:
API
Value
﻿quantity﻿
1
﻿productId﻿
The product id of the purchase.
﻿price﻿
The price of the product.
﻿currencyCode﻿
The currency code of the price.
﻿transactionId﻿
The transaction id of the purchase if available.
As a result, no template needs to be configured. 
Attributes
Braze supports attributes.
Attribute
Example
"HAS_ACTIVE_SUBSCRIPTION": {
  "templates": {
    "name": "has_active_subscription"
  }
}
"HAS_ACTIVE_SUBSCRIPTION": {
  "templates": {
    "name": "has_active_subscription"
  }
}
﻿
Additional supported functionality
Push
﻿https://www.braze.com/docs/user_guide/message_building_by_channel/push﻿
This feature is enabled as provided by Braze.
In-app messaging
﻿https://www.braze.com/docs/user_guide/message_building_by_channel/in-app_messages﻿
This feature is enabled as provided by Braze.
How to configure
Native Purple App
Any native Tracking Service is configured in the Purple Manager.﻿
Enable SDK
Settings location
"Your app" => "Consent/Push/Analytics" => "Analytics (General/iOS/Android/Web)"
Setting
Description
Enable Braze
To enable the Braze SDK in your app, activate this checkbox.
Braze API Key
The API key. Provided by Braze.
Apple privacy / ATT
Settings location
"Your app" => "Consent/Push/Analytics" => "Privacy"
Consent management
Settings location:
"Your app" => "Consent/Push/Analytics" => "Consent Management"
Setting
Description
Vendor-ID for Braze
The Vendor-ID is provided by the consent management platform.
Web integration
Purple does not support Braze web integration.

Site	URL
Website	https://www.braze.com
Documentation	https://www.braze.com/docs

Platform	URL
Android	https://github.com/Appboy/appboy-android-sdk
iOS	https://github.com/Appboy/appboy-ios-sdk
Web	not supported by Purple

	Templates	Parameter
Actions	action	not supported
Purchases*	none	not supported
Attributes	name	not supported

API	Value
quantity	1
productId	The product id of the purchase.
price	The price of the product.
currencyCode	The currency code of the price.
transactionId	The transaction id of the purchase if available.

Setting	Description
Enable Braze	To enable the Braze SDK in your app, activate this checkbox.
Braze API Key	The API key. Provided by Braze.

Setting	Description
Vendor-ID for Braze	The Vendor-ID is provided by the consent management platform.

Updated 19 Jul 2024

Did this page help you?

AT Internet

Chartbeat