Cocoapods Integration

Easy setup Apple push notifications for iOS apps

📘

Our preferred installation method is via Swift Package Manager.

📘

To upgrade to the latest version of our SDK, follow these instructions.

Setting up push notifications for your iOS app is easy. Push notifications are the ideal solution to re-engage users and bring them back to your app. This guide tells you how to configure an iOS app to send and receive push notifications on any Apple mobile device, whether it's an iphone, an ipad, or an Apple watch.

Estimated setup time: 15 minutes.

📘

Using a cross-platform framework?

We have specific instructions for Cordova, React Native and Flutter.

Prerequisites

Getting started with WonderPush is easy.

You'll need:

• Xcode
• An iOS device such as an iPhone or an iPad
• An iOS Push Certificate (here's a how to obtain it)

If you haven't already, sign up for a free account on wonderpush.com.

📘

This guide uses Cocoa Pods. We also support [Swift Package Manager](doc: ios-push-notifications-quickstart), manual Framework integration and Carthage

Note: if you're upgrading from our SDK version 3.x? Follow this guide to update your integration.

Step 1. Create your project

Click on New Project:

Choose a name for your project and select iOS as a platform then click Create:

📘

Already have a project?

Just add the iOS platform to any existing project by going to Settings, selecting the first tab named after your project and clicking Edit. You'll be presented a form that lets you add a platform.

Step 2. Upload your push credentials

Get your Apple key with the Apple Push Notifications service (APNs) service enabled. You can list your existing keys here. Simply check the Enabled Services and note the Key ID as well as the Team ID displayed below your name in the top-right corner.

If you don't have one, here's how to create one. In a few words, head to the Apple developer website, go to Accounts, then click on Keys in the Certificates, Identifiers & Profiles column, and click the + button on the top left to add a new key.

Check Apple Push Notifications service (APNs), then click Continue:

If instead you see the following red message, this means that you should instead reuse an existing key. As Apple will not let you download the key again after its registration, you will need to use for the .p8 file that you downloaded at that time.

📘

How should Apple keys be managed for the Apple Push Notifications service (APNs)

Apple imposes a maximum of 2 keys simultaneously valid for the Apple Push Notifications service (APNs). Such keys are valid for all applications (Bundle ID or App ID) on your account (Team ID).

Limiting to 2 keys enables you to have one key used for all your push notification needs across all your WonderPush projects (you'll need to upload the same key for each of your projects) or even push providers, and perform a rolling replacement of your key with no downtime.
You would create a second key, temporarily having 2 valid keys at a time, replace every WonderPush project or services that need to send push notifications, and finally revoke the previous key, leaving you again with a single existing key.

In the next screen click Register.
In the next screen, note your Key ID, and your Team ID in the top right corner.
Then click Download. Please do keep this .p8 file in a secure location (see the above callout about key management.)

You will then need to know your Bundle ID:

1. Open your project in Xcode
2. Click on your project in the file browser on the left
3. Click on your app target in the list
4. Open the General tab
5. Your Bundle identifier (aka Bundle ID) is in the Identity section

Now go to Settings / Platforms, click the iOS application section title and fill drop your .p8 file:

• Fill the Key ID, Team ID and Bundle ID if necessary. Check their values if they are pre-filled.
• Click Save.

Step 3. Create the notification service extension

🚧

If you're using React Native, Flutter, Cordova or Ionic, make sure to follow the steps specific to your platform:

• React Native
• Flutter
• Cordova
• Ionic

In Xcode, select File / New / Target..., and choose Notification Service Extension:

Enter WonderPushNotificationServiceExtension as the name for your new target:

When Xcode prompts you to activate the new scheme, answer Cancel to keep Xcode building and debugging your app instead of the extension:

If you activate by mistake, switch back to your app's scheme from the dropdown menu located next to the play button.

Set the Deployment Target of your Notification Service Extension to 11.0 (or the minimum version accepted by Xcode):

Make sure to use Automatic Signing for the extension target:

📘

If you're getting the following error, make sure to set up Automatic Signing for the extension:

Provisioning profile "XXX" has app ID "YYY", which does not match the bundle ID "YYY.WonderPushNotificationServiceExtension".

Step 4. Integrate WonderPush to your Xcode project

Setup CocoaPods on your system if you haven't already.

If you do not wish to use CocoaPods, you can follow our Manual Integration Guide.

🚧

Please close your Xcode project before proceeding

If your project doesn't have a Podfile, run the following command from the same directory that contains your .xcodeproj:

pod init

Add WonderPush to your Podfile:

# Uncomment the next line to define a global platform for your project
# platform :ios, '16.0'
  
target 'MyApp' do
  # Comment the next line if you're not using Swift and don't want to use dynamic frameworks
  use_frameworks!
    
  # Pods for MyApp
  pod 'WonderPush', '~> 4.0'
end

target 'WonderPushNotificationServiceExtension' do
  platform :ios, '11.0'
  # Comment the next line if you're not using Swift and don't want to use dynamic frameworks
  use_frameworks!

  # Pods for WonderPushNotificationServiceExtension
  pod 'WonderPushExtension', '~> 4.0'
end

Finally, run:

pod install

Open the newly created <my-app>.xcworkspace file.

🚧

From now on, please use the .xcworkspace file rather than the .xcodeproj file to work on your project (but keep both).

Step 5. Add device capabilities

Select your app's main target and, under the Capabilities tab, make sure:

• the Background Modes capability is ON,
• the Remote notifications background mode is checked,
• the Push Notifications capability is ON.

Step 6. Add required code

Take note of your Client ID and Client Secret from the iOS app section of the Settings / Platforms page:

Method 1. Storyboard

If you're using Storyboard, open your AppDelegate and add the following, adapting YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with the values you've noted above:

import WonderPush

func application(_ application: UIApplication, willFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        WonderPush.setClientId("YOUR_CLIENT_ID", secret: "YOUR_CLIENT_SECRET")
        WonderPush.setupDelegate(for: application)
        WonderPush.setupDelegateForUserNotificationCenter()
        return true
}

#import <WonderPush/WonderPush.h>
  
- (BOOL)application:(UIApplication *)application willFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [WonderPush setClientId:@"YOUR_CLIENT_ID" secret:@"YOUR_CLIENT_SECRET"];
    [WonderPush setupDelegateForApplication:application];
    [WonderPush setupDelegateForUserNotificationCenter];
    return YES;
}

Prompt users as soon as the app is launched by adding code to the application:didFinishLaunchingWithOptions method of your app delegate. We recommend you move this code to a more suitable place in the user journey later you're done setting up WonderPush.

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // TODO: Move this in a more suitable place in the user journey.
    WonderPush.subscribeToNotifications()
    return true
}

Method 2. SwiftUI

If you're using SwiftUI, start by creating an AppDelegate if you haven't got one already.

1. Create a new Cocoa Touch Class in Swift
2. Name it AppDelegate

Enter the following code in your AppDelegate, adapting YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with the values you've noted above.

//
//  AppDelegate.swift
//

import UIKit
import WonderPush

class AppDelegate: NSObject, UIApplicationDelegate {
    func application(_ application: UIApplication, willFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        WonderPush.setClientId("YOUR_CLIENT_ID", secret: "YOUR_CLIENT_SECRET")
        WonderPush.setupDelegateForUserNotificationCenter()
        return true
        
    }
    // WonderPush needs to be called whenever the following methods are called
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        WonderPush.application(application, didFinishLaunchingWithOptions: launchOptions)
        return true
    }
    func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
        WonderPush.application(application, didRegisterForRemoteNotificationsWithDeviceToken: deviceToken)
    }
    func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
        WonderPush.application(application, didFailToRegisterForRemoteNotificationsWithError: error)
    }
    func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
        WonderPush.application(application, didReceiveRemoteNotification: userInfo, fetchCompletionHandler: completionHandler)
    }
}

Prompt users as soon as the app is launched by adding code to the application:didFinishLaunchingWithOptions method of your app delegate. We recommend you move this code to a more suitable place in the user journey later you're done setting up WonderPush.

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        WonderPush.application(application, didFinishLaunchingWithOptions: launchOptions)
        
        // TODO: Move this in a more suitable place in the user journey.
      	// Add the following line to prompt push permission
        WonderPush.subscribeToNotifications()
        return true
    }

Make sure to reference that AppDelegate by adding a single line of code in your SwiftUI App struct.

//
//  ExampleApp.swift
//

import SwiftUI
import WonderPush

@main
struct WonderPushExampleApp: App {

    // Make sure to add the following line
    @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

Update the service extension

Regardless of whether you are using Storyboard or SwiftUI, we'll modify the code of the Notification Service Extension you created in Step 3.

Replace the whole contents of NotificationService.swift or (NotificationService.h and NotificationService.m for Objective-C) with :

import WonderPushExtension

class NotificationService: WPNotificationServiceExtension {

    override class func clientId() -> String {
        return "YOUR_CLIENT_ID"
    }

    override class func clientSecret() -> String {
        return "YOUR_CLIENT_SECRET"
    }

}

#import <WonderPushExtension/WonderPushExtension.h>

@interface NotificationService : WPNotificationServiceExtension

@end

#import "NotificationService.h"

@implementation NotificationService

+ (NSString *)clientId {
    return @"YOUR_CLIENT_ID";
}

+ (NSString *)clientSecret {
    return @"YOUR_CLIENT_SECRET";
}

@end

Once again, adapt YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with the values you've noted above, the same you just gave to your AppDelegate.

🚧

Solving this error: Sandbox: rsync(79527) deny(1) file-write-create (...)/Frameworks/WonderPush.framework/WonderPush.bundle

Make sure "User Script Sandboxing" is set to NO in your build settings

Receive your first push!

Let take your iphone or your ipad, and discover your first iOS Push notification.

📘

To test push notifications, you'll need to use a real device as the simulator doesn't support push notifications.

Build & run your application and get the permission prompt you've configured:

Wait a couple of minutes and receive the default welcome notification:

👍

Congratulations, you're done!