Braze Integration

  • Published on Nov 19, 2025
  • 2 minute(s) read
  • J
 Prev Next

Overview

This article outlines the integration of Braze into the VL Platform, covering the essential components required for push notifications and analytics tracking. The integration applies to Android, iOS, and Web applications as well as the backend services. The current scope is limited to push notifications and In App notifications with deeplink support and analytics event tracking.

SDK Setup

To integrate Braze into the VL apps, start by setting up the appropriate SDKs for your platform.

SDK Repositories include

  • Android: Android SDK GitHub Repository

  • iOS (Swift): iOS SDK GitHub Repository

  • Web: Web SDK GitHub Repository

  • Each repository includes platform-specific instructions for integrating and initializing the Braze SDK.

    SDK Configuration

After setting up the SDKs, follow the platform-specific configuration guides provided by Braze:

Push Notification Integration

Braze provides support for push notifications across Android, iOS, and Web. This includes capabilities like deeplinking, which allows users to navigate directly to specific app screens from a notification.

Push Notification SDKs

  • Android: android-sdk-ui

  • iOS: BrazeKit with BrazeNotificationService & BrazePushStory

  • Web: Integrated with full/core SDK

Implementation Guides

Follow the steps below for each platform:

Analytics Integration

Analytics integration enables tracking of user behavior across the app platforms and backend services. Braze SDKs automatically collect some user data and also support the tracking of custom events.

Analytics SDKs

  • Android: android-sdk-base

  • iOS: BrazeKit

  • Web: Full/Core SDK

Implementation Guides

Auto-Collected User Data

The following data is automatically collected by the Braze SDK:

  • First App Opened

  • Last App Used

  • Total Sessions Count

  • Device OS and other environment information

Braze Standard Attributes

User Profile Field

Data Type

Information

Required

View Lift Passing

country

String

ISO-3166-1 alpha-2 country code (e.g., GB)

No

Yes

gender

String

M, F, O, N, P, or nil

No

Yes

home_city

String

Home city (e.g., London)

No

Yes


VL Custom Attributes

Old Custom Attribute

Old Status

New Custom Attribute

New Status

Definition

subscription_status_bc

active

subscription_status

COMPLETED

User has an active subscription and should have access to your platform

PENDING_CANCEL_SF

TRUE

subscription_status

DEFERRED_CANCELLATION

When a user cancels an active subscription before the end of the billing cycle. Auto-renewal is disabled. Users still have access until the end date, after which status becomes CANCELLED.

subscription_status_bc

CANCELED

subscription_status

CANCELLED

When a user cancels the subscription, the subscription status updates to CANCELLED.

–

–

subscription_status

SUSPENDED

Subscription suspended due to inability to collect payment.

–

–

subscription_status

PAUSED

(Google Play only) User has paused subscription, preventing further payments.

–

–

subscription_status

HOLD

(Google Play only) Subscription placed on hold, typically due to declined credit card payment.



Backend Attribute.             Description 

ExternalId    

Optional Id on which the details need to be updated

Email         

Optional Id on which the details need to be updated

FirstName     

Braze In-Built Attribute

LastName    

Braze In-Built Attribute

LastLogin 

Braze In-Built Attribute

RegistrationDevice

Custom Attribute

JoinDate    

Custom Attribute

Source      

Custom Attribute

Country         

Braze In-Built Attribute

HomeCity     

Braze In-Built Attribute

EmailSubscribe 

Braze In-Built Attribute

SubscriptionStatus

Custom Attribute

MvpdProvider    

Custom Attribute

UserId        

Custom Attribute


Backend Subscription events

EventSubscriptionPaymentCompleted = "subscription_payment_completed"

EventPlanUpgrade   = "subscription_upgrade_completed"

EventSubscriptionCanceled  = "subscription_canceled"

EventPlanDowngrade = "subscription_downgrade_completed"

EventPlanReactivate  = "subscription_reactivate_completed"

EventUnknown  = "unknown_event"

UpdateTypeUpgrade = "upgrade"

UpdateTypeDowngrade  = "downgrade"


Configuring Braze Integration in CMS

  1. Log in to AppCMS.

  2. Navigate to Settings > Notification and engagement channels > Enable the Braze integration toggle.

  3. Enter the Braze Platform configs 

    1. Enter API keys & Enter base URL 

    2. Select Platform