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    

The Installation object

This object describes a push notification installation.

The installation object represents the link between a device or browser and a WonderPush project.

Installation objects for your project are listed on every segment detail page of the online dashboard.

Installation objects hold the most important piece of data: the push token. The push token is required by device makers (Apple for iOS devices, Google for Android devices and Chrome browsers, Mozilla for Firefox browsers) in order to send a push notification to the corresponding device.

Installation objects also hold informative data about the device they are linked to. WonderPush lets you use this data for segmentation.

A sample installation

Below is a JSON representation of an example installation object. In this document, we'll go through all its fields.

{
  "id": "e2ba48f97a45be39f6c921e7b7a2adf65ad451b5",
  "applicationId": "01906i1feoq2cu1p",
  "userId": null,
  "creationDate": 1410539794529,
  "updateDate": 1410539796299,
  "accessToken": "Hkn6z9fZCEUJBvoRtasoqT2LDYPxDOh4ftGQRpnEn71NFw4VPQdySx8gJi7xrwHWl",
  "application": {
    "id": "01906i1feoq2cu1p",
    "sdkVersion": "Android-1.1.0.0",
    "version": "1.0"
  },
  "device": {
    "id": "c51c72f4a3700183",
    "platform": "Android",
    "screenHeight": 1186,
    "model": "Nexus 4",
    "osVersion": "19",
    "screenWidth": 768,
    "brand": "LGE",
    "configuration": {
      "carrier": "Bouygues Telecom",
      "country": "FR",
      "currency": "EUR",
      "locale": "fr_FR",
      "timeZone": "Europe/Paris"
    },
    "screenDensity": 320
  },
  "preferences": {
    "subscriptionStatus": "optIn"
  },
  "pushToken": {
    "meta": {
      "updateDate": 1410539796298
    },
    "data": "02J0fDm4dwsAylLXKr47YhNwEaZU1EfcLww5LGlye_5mGGgaGcbrXtXU6HKCUXabGUHBNX0V4htJvHBAflIgABe4H5SskfwA_Ie3WHmjAfiy2whXUvMWK5gH6jRZOwQJltiMbilfoPxvF"
  },
  "custom": {}
}

Installation ID

A unique identifier for this installation object. Use it to send a notification to this installation only, via the API or the online dashboard with an installation id segmentation rule.

User ID

If you've attached this installation to one of your own user IDs, this field will hold its value. Null otherwise.

Creation date

Number of milliseconds since 01/01/1970 UTC when the installation was created.

Update date

Number of milliseconds since 01/01/1970 UTC when the installation was updated.

Access token

The access token that this installation uses to converse with WonderPush via our SDKs.

Application ID

The unique identifier of your WonderPush project.

Application SDK version

The version of our SDK that was last used to create or update this installation.

Application Version

The version of your application that was last used to create or update this installation. There's a dedicated segmentation criterion for this data.

Device ID

A unique identifier inferred from the device's properties. Should be the same for all the installations of a given project on a particular device.

Device Platform

One of iOS, Android or Web.

Device screen width / height

The width / height of the screen.

Device model

The model of the mobile device or user agent of the browser.

Device OS version

The version of the mobile device's OS or browser.

Device brand

Apple for iOS devices, name of the maker for Android devices, Chrome or Firefox for web browsers.

Device carrier

For mobile devices, name of the carrier when available.

Device configuration country

For mobile devices, ISO code of the carrier's country when available.

Device configuration currency

For mobile devices, ISO code of the carrier's currency when available.

Device configuration locale

ISO code of the device's or web browser's locale.

Device configuration timezone

ISO code of the device's or web browser's timezone.

Device screen density

For mobile devices, the pixel density ratio. 2 for Apple retina devices.

Preferences subscription status

optIn for reachable installations, optOut for soft opt-out installations. Missing or null otherwise.

Push token

The push token is a piece of data required by device makers in order to send a push notification to the corresponding device.

Every device maker has their own wording (some call it device token) and documentation on the subject:

Since WonderPush is cross platform, we just talk about push token.

Push token meta update date

Number of milliseconds since 01/01/1970 UTC when the push token was updated or created.

Properties

Properties you put using our SDKs are stored in an object accessible via the key custom.

The Installation object


This object describes a push notification installation.

Suggested Edits are limited on API Reference Pages

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