Last updated: Dec 12 2018

Area: Episerver Campaign Applies to versions: Not applicable

iOS integration

This topic describes how to integrate your iOS app for receiving push messages via Episerver Campaign. It also includes access to the Software Developer Kit (SDK) and documentation to receive required code components for integration into your app.


See Mobile Push how to set up required mobile push components before you start developing.

System requirements

  • iOS version 8.0 or higher.

Register with Firebase Cloud Messaging (FCM)

  1. Open the Firebase console and log in using your Google account.
  2. Click Add project and create a new project for the app.
  3. Click Settings and then Project settings.
  4. Open the Cloud Messaging tab and note the Legacy server key and sender ID for passing to Episerver Campaign.
  5. Click Settings and then Users and permissions.
  6. In the navigation on the left-hand side, click Service accounts.
  7. At the top of the navigation, click + CREATE SERVICE ACCOUNT.
  8. Enter the name of the service account and provide an optional service account ID.
  9. Select Furnish a new private key and activate the JSON option.
  10. Click Create and save the generated JSON file. The new service account appears in the overview along with the key ID.

Download SDK

Download the following for iOS:

Integrate iOS SDK

  1. Log in to FCM with your Google Developer account. 
  2. Download the GoogleService-Info.plist with the iOS onfiguration for FCM.
  3. Add the iOS source code including dependencies (see Install iOS source code).
  4. In -application:didFinishLaunchingWithOptions:, create an instance of OPPushClient with the package name and authorization token which you received from customer support.
  5. Call up required -application* methods, which are specified in OPPushClient.h header by your app delegate.

    Note: Use userinfo in the app delegate -application:didReceiveRemoteNotification* methods to process incoming messages.

Install iOS source code

  1. In your Podfile, enter the following extension, according to the cocoapods.org rules:
    pod 'Google/CloudMessaging', '~> 1.1.0'
  2. Add the iOS source code to your project.

Related topics

Do you have feedback on this documentation? Send an email to documentation@episerver.com. For development-related questions and discussions, refer to our Forums on https://world.episerver.com/forum/