Skip to content

About the Braze Swift SDK

The Braze Swift SDK helps you integrate Braze messaging, analytics, and user engagement capabilities into your application.

To get started, refer to the following resources:

Quickstart

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// 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
        // ...
    }
}
1
AppDelegate.braze?.changeUser(userId: "Jane Doe")

See the Braze Developer Guide for advanced integration options.

Version Support

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

  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

1 Push notifications not supported on tvOS
2 Geofence monitoring not supported on tvOS and visionOS

Examples

Explore our examples project which showcases multiple features’ integrations.

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 (early access) braze-inc/braze-swift-sdk-prebuilt-mergeable

Contact

If you have questions, please contact [email protected].

For repository details and sample projects, see https://github.com/braze-inc/braze-swift-sdk.

New Stuff!