Braze Swift SDK

To learn more, see the following resources:

• Braze User Guide
• Braze Developer Guide

Quickstart

The following snippets show the minimum configuration required to add the Braze Swift SDK to your app.

// AppDelegate.swift
import BrazeKit

class AppDelegate: UIResponder, UIApplicationDelegate {
  // ...
  static var braze: Braze? = nil

  // ...
   func application(
      _ application: UIApplication, 
      didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {
        // ...
        let configuration = Braze.Configuration(
            apiKey: "YOUR-APP-IDENTIFIER-API-KEY",
            endpoint: "YOUR-BRAZE-ENDPOINT"
        )
        let braze = Braze(configuration: configuration)

        AppDelegate.braze = braze
        // ...
    }
}

AppDelegate.braze?.changeUser(userId: "Jane Doe")

For more information about advanced integration options, see the Braze Developer Guide.

Version support

The following table lists the minimum supported versions for tools used by the Braze Swift SDK.

Tool	Minimum supported version
iOS	12.0+
Mac Catalyst	16.0+
tvOS	12.0+
visionOS	1.0+
Xcode	26.0+ (17A324)

Package Managers

• Swift Package Manager
• CocoaPods

Libraries

The following table describes each library in the Braze Swift SDK.

	iOS	tvOS	macCatalyst	visionOS
BrazeKit Main SDK library providing support for analytics and push notifications.	✅	✅1	✅	✅
BrazeUI Braze-provided user interface library for In-App Messages and Content Cards.	✅	n/a	✅	✅
BrazeLocation Location library providing support for location analytics and geofence monitoring.	✅	✅2	✅	✅2
BrazeNotificationService Notification service extension library providing support for rich push notifications.	✅	n/a	✅	✅
BrazePushStory Notification content extension library providing support for Push Stories.	✅	n/a	✅	✅

¹ Push notifications not supported on tvOS
² Geofence monitoring not supported on tvOS and visionOS

Examples

Explore our examples project, which showcases sample integrations for multiple features.

Alternative Repositories

Variant	Repository	GH Issues, SDK info
→ Sources and Static XCFrameworks	braze-inc/braze-swift-sdk	✓
Static XCFrameworks	braze-inc/braze-swift-sdk-prebuilt-static	✗
Dynamic XCFrameworks	braze-inc/braze-swift-sdk-prebuilt-dynamic	✗
Mergeable XCFrameworks	braze-inc/braze-swift-sdk-prebuilt-mergeable	✗

Contact

For questions, contact Braze Technical Support for assistance.