WonderPush Documentation

The WonderPush Developer Hub

Welcome to the WonderPush developer hub. You'll find comprehensive guides and documentation to help you start working with WonderPush as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

iOS Quickstart

How to set up WonderPush push notifications on iOS apps

Estimated setup time: 15 minutes.

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)
  • An Xcode project your iOS application

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

This guide uses Cocoa Pods, which is our preferred integration method. We also support manual Framework integration and Carthage

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 certificate

Go to Settings / Platforms, click the iOS application section title and fill in:

  • your push certificate by clicking the Browse button,
  • the push certificate password if appropriate.

Be sure to check how to use WonderPush in both Sandbox & Production.

Step 3. Create the notification service extension

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 10.0:

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, '9.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', '~> 3.0'
end

target 'WonderPushNotificationServiceExtension' do
  platform :ios, '10.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', '~> 3.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 tab of the Settings / Configuration page:

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;
}

Let's add the code that will prompt users to subscribe to push notifications. We recommend you place this code in a more suitable place in the user journey, but we'll do it at launch time for now. In your AppDelegate:

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // Override point for customization after application launch.
    // Prompts users to subscribe to push notifications.
    // Move this in a more suitable place in the user journey.
    WonderPush.subscribeToNotifications()
    return true
}
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.
    // Prompts users to subscribe to push notifications.
    // Move this in a more suitable place in the user journey.
    [WonderPush subscribeToNotifications];
    return YES;
}

Finally, 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 {
}
#import <WonderPushExtension/WonderPushExtension.h>

@interface NotificationService : WPNotificationServiceExtension

@end
#import "NotificationService.h"

@implementation NotificationService

@end

Receive your first push!

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!


What's Next

Learn how to set properties and send events using our SDK.

Properties
Events
iOS SDK

iOS Quickstart


How to set up WonderPush push notifications on iOS apps

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.