Setup

Intallation

  1. Add the required Capacitor plugin

    npm install cleverpush-capacitor-sdk
npx cap sync

Setup Android

  1. Add Firebase to your Android project. official docs
  2. Get your FCM Sender ID & FCM Server API Key.
  3. Login/Register on CleverPush

Setup iOS

  1. Enable the required capabilities

    1. Go to your root project and switch to the tab "Capabilities"

    2. Enable "Push Notifications"

    3. Enable "Background Modes" and check "Remote notifications"

  2. Add Notification Service Extension

    This is required for correctly tracking notification deliveries and for displaying big images or videos in notifications.

    1. Select File > New > Target in Xcode
    2. Choose Notification Service Extension and press Next
    3. Enter CleverPushNotificationServiceExtension as Product Name, choose Objective-C as language and press Finish
    4. Press Activate on the next prompt
    5. Add the following at the bottom of your Podfile
    target 'CleverPushNotificationServiceExtension' do

  pod 'CleverPush/CleverPushExtension'

end
    1. Run pod install
    2. Open NotificationService.m and replace the whole content with the following:
    #import <CleverPushExtension/CleverPushExtension.h>

#import "NotificationService.h"

@interface NotificationService ()

@property (nonatomic, strong) void (^contentHandler)(UNNotificationContent *contentToDeliver);
@property (nonatomic, strong) UNNotificationRequest *receivedRequest;
@property (nonatomic, strong) UNMutableNotificationContent *bestAttemptContent;

@end

@implementation NotificationService

- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
    self.receivedRequest = request;
    self.contentHandler = contentHandler;
    self.bestAttemptContent = [request.content mutableCopy];

    [CleverPushExtension didReceiveNotificationExtensionRequest:self.receivedRequest withMutableNotificationContent:self.bestAttemptContent];

    self.contentHandler(self.bestAttemptContent);
}

- (void)serviceExtensionTimeWillExpire {
    [CleverPushExtension serviceExtensionTimeWillExpireRequest:self.receivedRequest withMutableNotificationContent:self.bestAttemptContent];

    self.contentHandler(self.bestAttemptContent);
}

@end
    1. In the main app target → Build Phases → Embed App Extensions, keep “Copy only when installing” unchecked. Match the extension Version and Build with the main app.

  3. Add App Group (required for delivered count, getNotifications, and badge updates)

    Use the main app bundle ID, not the extension’s:

    group.YOUR.BUNDLE.ID.cleverpush

    Enable the same App Group on both the app target and CleverPushNotificationServiceExtension.

    If the dashboard Delivered count is wrong or the delivery API is never called, the Notification Service Extension is not running. Confirm:

    • NotificationService calls CleverPushExtension didReceiveNotificationExtensionRequest
    • The push payload includes mutable-content
    • Embed App Extensions does not have “Copy only when installing” checked
    • You are testing on a physical device

    You can also upload an APNs Auth Key in the CleverPush channel settings instead of a .p12 certificate (see the iOS Setup page).

  4. Create your iOS push certificate

    1. Open Keychain Access on your Mac. (Application > Utilities > Keychain Access).
    2. Select Keychain Access > Certificate Assistant > Request a Certificate From a Certificate Authority...
    3. Select the "Save to disk" option and enter any information in the required fields
    4. Go to the Apple developer portal, select your app and press "Edit"
    5. Enable "Push notifications" and press "Done"
    6. Go to the Create new certificate page, select "Apple Push Notification service SSL" and press "Continue"
    7. Select your Application Bundle ID and press "Continue"
    8. Press "Choose File...", select the previously generated "certSigningRequest" file and then press "Generate"
    9. Press "Download" and save your certificate
    10. Click on the downloaded .cer file, Keychain Access should open
    11. Select Login > My Certificates then right click on your key and click "Export (Apple Production iOS Push Services: com.your.bundle)..."
    12. Give the file a unique name and press save, be sure to leave the password field blank!
    13. Upload your certificate in the CleverPush channel settings
← ChangelogMethods →