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    

Notifications

List, create and edit notifications directly from the online dashboard.

Notifications page

The notifications page displays a list of all notifications configured for your Project. This list includes built-in notifications as well as your own notifications.

Each notification comes with a set of controls allowing you to fire or activate, edit, duplicate and delete it:

Some notifications have an activation switch rather than a fire button: they are automated notifications.

Not familiar with Automation?

Check out our Automation overview.

Clicking on the notification title or the notification row takes you to the Notification detail page.

When the notification has been sent and clicked, its row displays a summary containing Notifications sent, Notifications clicked and Click through rate:

Notification detail page

The notification detail page contains all the information related to a notification:

  • its general information (identifier, name, segment)
  • a set of controls to fire, activate, edit and delete the notification,
  • a preview of the notification content,
  • detailed metrics including a summary, a graph and a table.

The metrics section of the notification page is similar to the metrics section of the overview page except all metrics are limited to that notification. To fully understand these metrics, be sure to read the metrics documentation of the Overview page.

Create / edit notification page

The notification creation and edition page can be reached through the controls of the Notifications page and Notification detail page.

The creation and edition process is divided into 4 parts:

  1. Schedule: specify how and when a notification is sent,
  2. Compose: edit the notification content,
  3. Target: choose who receives the notification,
  4. Advanced: setup additional notification properties such as payload, timezone management, etc.

Schedule

In this part of the creation and edition process, you choose the notification name and determine when is the notification sent.

Notification name

The notification name is only here to help you distinguish notifications from each other. It is never shown to end-users.

Trigger

There are 5 types of trigger:

Compose

The Compose tab is where you edit the notification content. There are multiple types of notifications and each has its own composition form. By default, the Simple type is selected:

Basic composition form

This form is common to all notification types except the Data type which doesn't accept content. The Text field is mandatory and you can also add a title. Those will be displayed on two different lines, as the preview will show.

This form allows you to determine what happens when you click on the notification. You have the following choices:

  • Open application: this is the default choice and simply opens your application or website when the notification is clicked,
  • Open URL: lets you choose an HTTP(S) URL that will be opened when the notification is clicked,
  • Open deep link: lets you specify an application URL to be opened upon notification click,
  • Let application code decide: when you choose this option, WonderPush will not do anything upon notification click and it is up to your app or website code to listen to the notification click and take action. See Advanced click handling.

Preview

On the right hand-side of the edition form, you'll find a preview that accurately shows how the notification will look on iOS, Android or the Web:

Adding actions

It is possible to attach additional actions performed upon click on the notification. You can:

Please note that WonderPush automatically tracks a @NOTIFICATION_OPENED event whenever users click on a notification.

Buttons

Some notification types allow you to include buttons:

  • Simple + buttons,
  • Picture + buttons,
  • Big picture + buttons.

Buttons appear directly on the notification and can be configured using the button form:

You can choose a label, an icon and an action to perform upon button click. You can also attach additional actions to send events, update the installation or trigger a registered callback. See adding actions.

In-app component

On the iOS and Android platforms, you can include in-app components that will be displayed when the notification is clicked.

Picture & Big picture

Some notification types allow you to include pictures directly within notifications:

  • Picture,
  • Big picture,
  • Picture + buttons,
  • Big picture + buttons.

To include a picture, specify its URL (it must be HTTPS) or simply drag and drop an image on the Drop file here to upload zone.

A/B testing variants

WonderPush lets you setup A/B tests for your notifications. Setting up an A/B test is done by clicking the Add a variant button. This results in an additional edition form being displayed. When it is time to send your notification, WonderPush will alternatively pick a version. Find out more about A/B testing.

Push data

On the iOS and Android platforms, you can choose to send “silent” notifications that will not be displayed but can be used to trigger behaviors in your app or website. See Push data.

Target

The Target tab lets you decide who receives your notification. You can choose to send your notification to your entire audience or to a segment of your choice.

We do not recommend you send notifications to your entire audience, as broadcast notifications tend to generate more un-subscriptions than targeted notifications.

Once you choose Send only to users within the segment..., the Target allows you to specify segment rules.

Please note that you can use any segment you've configured beforehand by selecting the Segment of audience rule type:

Advanced

The Advanced tab is the last step of the composition process and includes optional advanced settings.

Pressure management

The pressure management setting helps you cap the number of notifications you send to a particular user. To enable pressure management:

  • activate the Regulate sendings switch,
  • choose a category for your notification,
  • specify a maximum frequency.

See Pressure management.

Timezone management

This setting allows scheduled and periodic notifications to be sent at different times according to the user's timezone. It does not apply to notifications of type Manual, Behavior or API. See Timezone management to find out more.

Payload

Push notifications may specify a payload. There are two ways to specify that payload:

  1. by adding individual Key/Value pairs
  2. by specifying a JSON dictionary to be merged with the payload.

Each of those ways have a dedicated form. This form lets you specify individual Key/Value pairs:

This form allows you to specify a JSON dictionary to be merged with the push payload:

See Push data for more about using that payload in your app or website.

Sounds, badges and foreground

This section applies to mobile applications only.

The following form allows you to:

  • specify a sound to be played upon reception of the notification,
  • set the badge number on your app (Mobile apps only),
  • specify the Android notification channel:

Sound resource name (Android)

The name of an Android app resource already bundled in your app that contains the sound to be played.

Sound file name (iOS)

The name of an iOS bundle resource already packaged in your app that contains the sound to be played.

Badge number (iOS)

The integer value of your iOS app's badge to be set upon reception of the notification.

Notification channel id (Android)

Specifies the Android notification channel.

If application is in foreground

Allows you to specify the appropriate behavior when the notification is received while your app is in the foreground. Choices are:

  • Display an alert,
  • Drop notification,
  • Open notification and display any in-app (behaves as if user clicked the notification).

Expiration

Some notifications should not be seen by users after a certain amount of time. For example, you might not want a notification advertising a limited-time offer to be delivered after the offer expires. The following setting allows you to do exactly this by dropping any notification past a certain delay. See Notification expiration.

Templates

Templates allow you to easily create notifications by duplication. To set the current notification as a template, activate the following switch:

You will then be able to create notifications by duplicating this notification directly from the Create notification button:

Notifications


List, create and edit notifications directly from the online dashboard.

Suggested Edits are limited on API Reference Pages

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