/user/notification-settings

Application alerts are defined in the Backstack dashboard. Users can receive notifications via email, text, or in-app.

Current user alerts

Current user alerts are provided in the session object.

{
  "success": true,
  "message": "",
  "payload": {
    ...
    "alerts": [
      
    ],
    ...
  }
}

The alerts array is not filtered buy any access control constraints.

User notification settings

GET /user/notification-settings

Provides a collection list of all available alerts and the user's current notification settings.

{
  "success": true,
  "message": "",
  "payload": [
    {
      "id": "login",
      "title": "Login Alert",
      "description": "Notification of a successful login to your account.",
      "media": {
        "email": false,
        "text": false,
        "app": false
      }
    },
   ...
  ]
}

Update user notification settings

Post an array of notification settings to update the user's notification preferences.

POST /user/notification-settings
{
  "settings": [
    {
      "id": "login",
      "email": true,
      "text": true,
      "app": true
    }
    ...
  ]
}