Notifications

Table of Contents

1. Introduction
2. Endpoints

Introduction

The notifications system allows modules or other tools to communicate with the WiFi Pineapple user via the UI. You may specify a notification level, message, and optionally the name of the module that sent the notification.

Endpoints

Create Notification PUT /api/notifications

{
    "level": number,
    "message": string,
    "module_name": string
}

{
    "success": true
}

Get Notifications GET /api/notifications

[{
    "id": number,
    "message": string,
    "level": number,
    "time": string,
    "read": bool,
    "displayed": bool,
    "module_name": string
}]

Delete All Notifications DELETE /api/notifications

{
    "success": true
}

Delete Notification DELETE /api/notifications/:notificationId

{
    "success": true
}

Mark All Notifications as Read PUT /api/notifications/read

{
    "success": true
}

Mark Notification as Read PUT /api/notifications/:notificationId/read

{
    "success": true
}

Mark Notification as Displayed PUT /api/notifications/:notificationId/displayed

{
    "success": true
}