Cloudfive Push API Reference

Terminology. Because words are important

Cloudfive Push lets you identify users however you want -- as long as the identifier you choose is unique for all of your users. This is often the database id of your users, their unique username, or even their email but you can use whatever you want. We'll refer to this choice as the

Specifying API Version

Errors

Cloudfive Push will send json with an error attribute containing the error. For example,

{
  "success": false,
  "error": "Missing parameter: api_key"
}

Authentication

To authenticate with Cloudfive Push, the api_key must be sent as a parameter when making the request.

{
  "api_key": "your_api_key"
}

Sending a notification

Available endpoints

GET /push/notify
POST /push/notify
POST /push

Specifying users to receive your notification

There are three ways to specify to which users to send your notification: broadcasting which sends your message to every user of your app, specifying a single user identifier or finally specifying an array of user identifiers. Let's see examples of each of these options.

// Send to everyone
{
  "audience": "broadcast",
  "alert": "Hello from Cloudfive",
  "api_key": "your_api_key"
}

// Send to user 42
{
  "user_identifier": 42,
  "alert": "Hello from Cloudfive",
  "api_key": "your_api_key"
}

// Send to users 1, 2, 3, 5 and 8
{
  "user_identifiers": [1, 2, 3, 5, 8],
  "alert": "Hello from Cloudfive",
  "api_key": "your_api_key"
}

Push Parameters