2.1.1 Notifications object

The notifications object contains a list of notifications for a user.

The primary property of a notification is its type, which identifies the event. The other two properties (message and explanation) contain the text that can be presented to the user. These are provided as a convenience, since the client should be able to produce the text itself, based on the type property. The message and explanation texts are provided in the language of the user.

Example

{
  "total": 1,
  "notifications": [{
    "timestamp": "2015-06-12T07:16:23Z",
    "type": "FULL_PROFICIENCY",
    "message": "100% reached!",
    "explanation": {
      "text": "Well done! You have reached full proficiency for this drill.",
      "markup": [{
        "type": "bold",
        "offset": 0,
        "length": 10
      }]
    }
  }]
}

Fields