Skip to content

Rich push notifications

Learn how to set up rich push notifications for the Braze SDK.

Prerequisites

Before you can use this feature, you’ll need to integrate the Swift Braze SDK. You’ll also need to set up push notifications.

Setting up rich push notifications

Step 1: Creating a service extension

To create a notification service extension, navigate to File > New > Target in Xcode and select Notification Service Extension.

Ensure that Embed In Application is set to embed the extension in your application.

Step 2: Setting up the notification service extension

A notification service extension is its own binary that is bundled with your app. It must be set up in the Apple Developer Portal with its own app ID and provisioning profile.

The notification service extension’s bundle ID must be distinct from your main app target’s bundle ID. For example, if your app’s bundle ID is com.company.appname, you can use com.company.appname.AppNameServiceExtension for your service extension.

Step 3: Integrating rich push notifications

For a step-by-step guide on integrating rich push notifications with BrazeNotificationService, refer to our tutorial.

To see a sample, refer to the usage in NotificationService of our Examples app.

Adding the rich push framework to your app

After following the Swift Package Manager integration guide, add BrazeNotificationService to your Notification Service Extension by doing the following:

  1. In Xcode, under frameworks and libraries, select the add icon to add a framework.

    The plus icon is located under frameworks and libraries in Xcode.

  2. Select the “BrazeNotificationService” framework.

    The "BrazeNotificationService framework can be selected in the modal that opens.

Add the following to your Podfile:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

target 'YourAppTarget' do
  pod 'BrazeKit'
  pod 'BrazeUI'
  pod 'BrazeLocation'
end

target 'YourNotificationServiceExtensionTarget' do
  pod 'BrazeNotificationService'
end

# Only include the below if you want to also integrate Push Stories
target 'YourNotificationContentExtensionTarget' do
  pod 'BrazePushStory'
end

After updating the Podfile, navigate to the directory of your Xcode app project within your terminal and run pod install.

To add BrazeNotificationService.xcframework to your Notification Service Extension, see Manual integration.

Using your own UNNotificationServiceExtension

If you need to use your own UNNotificationServiceExtension, you can instead call brazeHandle in your didReceive method.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

import BrazeNotificationService
import UserNotifications

class NotificationService: UNNotificationServiceExtension {

  override func didReceive(
    _ request: UNNotificationRequest,
    withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void
  ) {
    if brazeHandle(request: request, contentHandler: contentHandler) {
      return
    }

    // Custom handling here

    contentHandler(request.content)
  }
}

Step 4: Creating a rich notification in your dashboard

Your Marketing team can also create rich notifications from the dashboard. Create a push notification through the push composer and simply attach an image or GIF, or provide a URL that hosts an image, GIF, or video. Note that assets are downloaded on the receipt of push notifications, so you should plan for large, synchronous spikes in requests if you are hosting your content.

Prerequisites

Before you can use this feature, you’ll need to integrate the Cordova Braze SDK. You’ll also need to set up push notifications.

Setting up rich push notifications

Step 1: Create a notification service extension

In your Xcode project, create a notification service extension. For a full walkthrough, see iOS Rich Push Notifications Tutorial.

Step 2: Add a new target

Open your Podfile and add BrazeNotificationService to the notification service extension target you just created. If BrazeNotificationService is already added to a target, remove it before continuing. To avoid duplicate symbol errors, use static linking.

1
2
3
4

target 'NOTIFICATION_SERVICE_EXTENSION' do
  use_frameworks! :linkage => :static
  pod 'BrazeNotificationService'
end

Replace NOTIFICATION_SERVICE_EXTENSION with the name of your notification service extension. Your Podfile should be similar to the following:

1
2
3
4

target 'MyAppRichNotificationService' do
  use_frameworks! :linkage => :static
  pod 'BrazeNotificationService'
end

Step 3: Reinstall your CocoaPods dependencies

In the terminal, go to your project’s iOS directory and reinstall your CocoaPod dependencies.

1
2

cd PATH_TO_PROJECT/platform/ios
pod install

Prerequisites

Before you can use this feature, you’ll need to integrate the React Native Braze SDK. You’ll also need to set up push notifications.

Using Expo to enable rich push notifications

For the React Native SDK, rich push notifications are available for Android by default.

To enable rich push notifications on iOS using Expo, configure the enableBrazeIosRichPush property to true in your expo.plugins object in app.json:

1
2
3
4
5
6
7
8
9
10
11
12
13

{
  "expo": {
    "plugins": [
      [
        "@braze/expo-plugin",
        {
          ...
          "enableBrazeIosRichPush": true
        }
      ]
    ]
  }
}

Lastly, add the bundle identifier for this app extension to your project’s credentials configuration: <your-app-bundle-id>.BrazeExpoRichPush. For further details on this process, refer to Using app extensions with Expo Application Services.

Github   Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!