To enable Push Notifications and In-App Messaging for an app, simply enable the Messaging feature within Kumulos, upload your APNS and/or FCM certificates and then integrate an SDK into your app project. As soon as you publish the update to the app stores you will then be able to send push notifications and in-app messages to your users.

If you are an agency, managing an app for a client, you can now send messages on their behalf as part of a retention and engagement service you can deliver for them or, you can let them do this from their Client Portal showing your brand.

Enable Messaging

Create a Client

Kumulos groups your Apps under Clients, usually the name of the company whose app you are building or optimizing. To add a new client click the primary action button from your agency console.

Add a Client

Fill in the name of the client. If you are managing an app for someone else, you can enable the Client Portal so they can send push notifications and in-app messages to their users. Click "Save" when done.

Add a Client

You will now be redirected to the client dashboard.

Add an App

Now, you can add an app for that client by clicking the primary action button. Fill in the name of the App, and optionally, add a brief description and upload an icon. Click "Save" when done.

Create an App

You will now be redirected to the dashboard for that app where you can enable Push Notifications.

Enable Messaging

To start a 30 day free trial, either select Messaging from the left menu or click the Start button next to Messaging on the App Dashboard.

Start using messaging

You will now see some more information about the Messaging feature.

Enable messaging

Click Enable when prompted. You will be asked to confirm that you wish to begin a 30 day free trial.

Confirm start trial

Click Yes, proceed when prompted. Your 30 day trial of messaging will begin.


Configure Gateways

In order to send messages to users of your app, you must configure one or more messaging gateways. For mobile push notifications, this will likely involve configuring the Apple Push Notification Service (APNS) and/or Firebase Cloud Messaging (FCM), uploading your push certificates to Kumulos and then integrating the SDK. For in-app messaging, you simply need to integrate the SDK. There is no additional configuration required for web push notifications.

Click CONFIGURE NOW or, expand 'Messaging' in the left menu and select 'Configuration'.

Configure Messaging Dashboard

You will now see the Messaging Configuration screen where you can add your APNS and/or FCM credentials and download the appropriate SDKs for your app.

Messaging Configuration Screen

Click the cog icon next to the platform you would like to configure to open the dialog where you can enter the required information to send push notifications to iOS devices via APNS and/or Android devices via FCM.

Configure Push Dialog

APNS Configuration

In order to send push notifications to iOS devices with Kumulos, you'll need to create certificates in the Apple Developer Member Center. The steps to complete this are shown in the video guide.

Configuring APNS for iOS with Kumulos

Safari Configuration

To send web notifications to desktop Safari, you'll need to create a separate Website Push Identifier Certificate in the Apple Developer Member Center. Please see our Web SDK Integration Guide for full details of how to create this certificate.

Once you have this certificate, expand 'Messaging' in the left menu, select 'Configuration' and click the cog next to the Safari icon and upload your certificate along with your site URL and icon.

FCM Configuration

In order to enable push notifications for Android with Kumulos, you'll need to set up an FCM project and configure push for your app. These steps are shown in the following video guide.

Enabling Push Notifications for Android

HCM Configuration

The latest Huawei handsets such as the P40 family of phones do not use FCM for push notifications and instead use Huawei Cloud Messaging (HCM). If you want to message all of your Android users, including those using Huawei phones, then in addition to FCM you also need to configure HCM.

Configure a project on the Huawei Developer Console, and enable the Push feature by following the Push Kit developer guide step 1. Note that your app needs a valid signing configuration for both debug and release builds. The SHA-256 fingerprint of your signing key is required to match the Huawei app configuration prior to continuing.

Once you have created the app, configure the HCM gateway in Kumulos. Expand 'Messaging' in the left menu, select 'Configuration' and click the cog next to the Huawei icon. You will also need to enter the App ID and App Secret from the Huawei Developer Console.

When integrating an SDK, ensure you also complete the additional steps to add Huawei Mobile Services dependencies, files, plugins and manifest entries to your project.


Download and Integrate an SDK

You can now download the appropriate SDK(s) for your mobile app by selecting an SDK from the list at the bottom of the Configuration screen.

Download SDK

Follow the integration guide for that SDK to initialize the Kumulos client in your app project. Please note that you will need the API Key and Secret Key shown on the App Dashboard to do this.

For web push notifications, you will need the Website & PWA SDK, which is distributed through a CDN or NPM. In addition to your API Key and Secret Key shown on the App Dashboard, you will also need the VAPID public key from the code snippets web push configuration dialog.

Web Push SDK Code Snippet for CDN

Please see the Website & PWA integration guide for more details.

Checking installs of your App

When you run your app on a simulator or install your app on a device, you can check that the SDK has been initialized correctly by selecting the app and clicking the Installs tab to see the ten most recent installs of your app. Click on an install, click the 'Push' tab and click Send Test Push.

Recent installs

If you do not receive the push notification, check the Error Log for any errors sending the push notification to the native push gateways. If you continue to experience problems, please don't hesitate to contact support who are standing by to help!


Reviewing your Configuration

To review your messaging gateway configuration, expand 'Messaging' in the left menu and select 'Configuration'. This will show how many installs are subscribed to receive push notifications and how many and users have opted in to receive in-app messages, broken down by platform.

Messaging Configuration

Viewing the Error Log

The Error Log will show any errors Kumulos has encountered sending push notifications to the native push gateways such as APNS or FCM. You can see the gateway where the error occurred, status code, the error message itself and when it happened. This can be help debug any problems.

Error Log

If you cannot see the Error Log, you may need to update to the latest APNS/FCM APIs.

Common Errors

Here are some common errors along with details of how to resolve them. However, if you continue to experience any problems, please don't hesitate to contact support who are standing by to help!

Device Token not for Topic

The DeviceTokenNotForTopic error from APNS usually means that the bundle id in the APNS certificate uploaded to Kumulos is different from the bundle id in the push token received from the install that the push was to be sent to.

Please check that your APNS certificate is a Sandbox & Production certificate and that the bundle id matches that of your XCode project as shown in this video.

Firebase Cloud Messaging API has not been used in project.

This error can sometimes be received from FCM depending how old your Firebase project is and where in the Google developer console you enabled FCM. Click on the link shown alongside this error in the Kumulos Error Log to go to your Google developer console and enable the Firebase Cloud Messaging API.

Updating your Configuration

The 'Push Notifications' widget is where you can reconfigure the native push gateways. This will show an amber, warning alert if the push certificate for APNS is due to expire in under two weeks.

APNS Certificate Expired

This will show a red critical alert if the certificate has expired! In other words, if you cannot now send notifications to your iOS app! These alerts will be reflected in the App Dashboard.

APNS Certificate Expired

Click on the cog to see the expiry date of the certificate and upload a new one.

APNS Certificate Expiry Date


Add users to the Testers Channel

The Testers channel is a special channel that you can use to send test messages to internal users from your team or your client, before sending the message to your wider audience.

Testers Channel

You can add users to the testers channel from the Install Explorer. Select the app and then click on the 'Installs' tab. This will show the most recent installs of your app (platform, device model, user identifier and install id). If you know your user identifier or install id, type this into the search box and click 'Lookup' to find your install.

Lookup Install

If you do not know your user identifier or install id, then simply uninstall and reinstall the app on your phone - this will create a new install. Once you have done this, click the 'Refresh' button and your install should be listed at the top. Expand the details to verify it is your device (model, location, timezone etc).

New Install

Once you have found your install, click on the 'Push' tab and toggle the switch next to the 'Testers (System Channel)' to subscribe add yourself to the channel. You can also send a test push to verify this indeed your device.

Add Install to Testers Channel

Now, whenever you are planning a new campaign, you can use the 'Test Send' button to send the push notification or in-app message everyone in the Testers channel, to see how the message will appear on your own device, before sending to your audience.

Test Send


Configure Web Push Prompts

To configure when and where to prompt website visitors to subscribe to web push notifications, expand 'Messaging' in the left menu, select 'Configuration' and then click the 'Add' button next to Push Prompts.

Add Prompt

You can add multiple prompts with different labels and appearances on different pages.

Show Prompt

First you need to select the event that should cause the prompt to show. This can be any analytics event tracked by your site (for example a product purchase event) or when some a page is viewed. You can also match properties of the analytics event (for example only a product purchased event where value exceeds a given amount) or the paths for the pages where the prompt should be shown.

To configure a prompt to show on some or all pages, select 'Page Viewed (system event)', with the 'Path' property and the 'In' operator. Under 'Includes' add the paths for the pages where the prompt should be shown. This can be the complete path or a wildcard. For example:

  • To show the prompt on every page, enter *, click 'Create Option *' then 'Add'
  • To show the prompt on every where path starts blog or news:
  • Enter /blog/* and click 'Create Option /blog/*'
  • Enter /news/* and click 'Create Option /news/*'
  • Click 'Add'

Show Prompt

You can have multiple path options in each 'Includes', in which case the prompt will be shown if the page matches one path or another path option. For example: where path starts blog or news:

Using or operator

You can also 'Add' multiple 'Include' filters, in which case the prompt will only be shown if the event includes every filter (i.e. event must match filter one and filter two etc). For example: when a product is purchased from category 'merchandise' with value greater than \$100 USD.

Using and operator

Please note if you include two paths like this then the prompt will only be shown if the page matches path one and path two. If this is not desired, click the 'x' icon to remove the filter.

If you do not want the prompt to show immediately on the page, toggle 'Delay showing' and enter how many seconds to wait before showing the prompt.

Labels

You can customize the text that will be shown when the user hovers over the prompt under labels.

Customize tool-tip

Appearance

Expand, 'Appearance' to customize the layout and color scheme for your prompt. You can position the prompt in the bottom left or right hand corner and change the background and foreground colors. As you do this, you can see a preview of how the prompt will look.

Customize tool-tip

Permission Request Overlay

To boost subscription rates, you can show some interstitial content whilst the browser is requesting push permission. Toggle 'Push Request Overlay' and enter a Heading and Body for the overlay.

Permission Request Overlay Config

Choose an Image

Click CHOOSE IMAGE to open your media library. Here, you can upload a new icon or select an icon previously uploaded.

To upload a new icon, click the upload primary action button. Click 'Choose File' to browse your computer and find the icon. Select any tags to help you find the icon later or to add a new tag, just start typing and click 'Create new tag'. Click 'Upload' to add the icon to your media library and use this for the overlay.

To use an icon you have previously uploaded, simply select the icon and click the tick primary action button. You can either scroll through your library or filter by the tags you have added previously.

Colors

You can customize the colors of the mask that will be overlayed on the page whilst the browser is requesting push permission, the background color of the overlay and the forground color for text by clicking the appropriate color picker icon. This will open the color picker. Click 'Confirm' once you have selected the desired color.

You can add links to your privacy policy, for example, by clicking 'ADD LINK'. Enter a label and the URL for the link. If you want to add another link, click 'ADD LINK' again. If you want to remove a link, click the trashcan icon next to it.

Click 'Save' to add the prompt. The SDK will now show this prompt within one hour.

Permission Request Overlay

To force the SDK to update its prompt configuration sooner (during testing for example), simply visit the page, remove the promptUpdated key from local storage (in Chrome Developer Tools, go to the 'Application' tab, under 'Storage' expand 'Indexed DB' and 'kumulos') and then reload the page.

Edit or Delete a Prompt

To edit or delete a prompt, expand 'Messaging' in the left menu, select 'Configuration', expand the context menu next to the prompt and select edit or delete as appropriate.

Add Prompt

Again, the SDK will update its prompt configuration within one hour.


Customize Web Push Icon

To customize the icon displayed with web push notifications, expand 'Messaging' in the left menu, select 'Configuration' and click the settings cog next to the web icon.

Customize Icon

You can either enter the URL to the icon or use your media library. Click CHOOSE/UPLOAD ICON to open your media library. Here, you can upload a new icon or select an icon previously uploaded.

To upload a new icon, click the upload primary action button. Click 'Choose File' to browse your computer and find the icon. Select any tags to help you find the icon later or to add a new tag, just start typing and click 'Create new tag'. Click 'Upload' to add the icon to your media library and use this for your web push notifications.

To use an icon you have previously uploaded, simply select the icon and click the tick primary action button. You can either scroll through your library or filter by the tags you have added previously.

Click CONFIGURE when done.

You can override this default icon when sending a notification.


That's it - you're all set to start sending notifications to your subscribers! Read on to learn about your messaging dashboard, how to use segments, channels, geofences and beacons to target your audience, how to send push notifications and in-app messages and how to create automation rules to automatically send notifications on a trigger such as a device entering or exiting a geofence.