Swift SDK repository guide

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:

• Braze User Guide
• Braze Developer Guide

Quickstart

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

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")

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.

Package Managers

• Swift Package Manager
• CocoaPods

Libraries

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

¹ 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

Contact

For questions, contact Braze Technical Support for assistance.

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