Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] APIM Portal Notifications #7985

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Notifications

The Notification System for WSO2 API Manager addresses a critical deficiency within the platform by introducing a mechanism to inform API Publishers and Developers about crucial changes to their APIs or subscriptions. This system aims to enhance communication, transparency, and responsiveness within the API management processes by providing timely alerts and updates regarding significant events such as workflow rejections, subscription blockings, and API-related updates.

<a name="NotificationsInThePublisherPortal"></a>

## Notifications in the Publisher Portal:

When a publisher user has new notifications, the bell icon on the header will display the number of unread notifications. These notifications include events such as workflow approvals or rejections and API-related updates.

</br>

[![Notification Icon](../../../assets/img/learn/notifications/notification-icon-publisher-portal.png)](../../../assets/img/learn/notifications/notification-icon-publisher-portal.png)

</br>

Clicking the bell icon will navigate you to the notification page, where you can manage your notifications.

</br>

[![Notification Page](../../../assets/img/learn/notifications/notification-page-publisher-portal.png)](../../../assets/img/learn/notifications/notification-page-publisher-portal.png)

</br>

### Manage Notifications

1. **Mark Notifications as Read:**

After reading a notification, you can click on the "Mark as Read" icon associated with each notification. This action visually grayed out the notification, indicating that it has been read. The unread count displayed with the bell icon will update automatically.

</br>

[![Mark as Read a Notification](../../../assets/img/learn/notifications/notifications-mark-as-read.png)](../../../assets/img/learn/notifications/notifications-mark-as-read.png)

</br>

To mark all notifications as read with one click, use the "Mark all as Read" button displayed on the top bar of the notification page.

</br>

[![Mark as Read all the Notifications](../../../assets/img/learn/notifications/notifications-mark-all-as-read.png)](../../../assets/img/learn/notifications/notifications-mark-all-as-read.png)

</br>

2. **Delete Notifications:**

If you want to delete a specific notification, click on the delete icon next to it. A delete confirmation dialog will appear, and upon confirmation, the notification will be deleted.

</br>

[![Delete a Notification](../../../assets/img/learn/notifications/notifications-delete.png)](../../../assets/img/learn/notifications/notifications-delete.png)

</br>

Similarly, you can delete all notifications at once by clicking the "Delete All" button on the top of the notification page.

</br>

[![Delete all Notifications](../../../assets/img/learn/notifications/notifications-delete-all.png)](../../../assets/img/learn/notifications/notifications-delete-all.png)

</br>

3. **Sort Notifications:**

By default, the notifications are shown in the order of latest first. However, if you prefer to view older notifications first, you can change the sort option to 'oldest'.

</br>

[![Sort Notifications](../../../assets/img/learn/notifications/notifications-sort.png)](../../../assets/img/learn/notifications/notifications-sort.png)

</br>


## Notifications in the Developer Portal:

The notification management process for developers is identical to that of publishers. Therefore, developers can follow the same instructions provided for [Notifications in the Publisher Portal](#NotificationsInThePublisherPortal).

</br>

[![Developer side notification page](../../../assets/img/learn/notifications/notifications-page-developer-portal.png)](../../../assets/img/learn/notifications/notifications-page-developer-portal.png)

</br>

### Conclusion:

The Notification System for WSO2 API Manager is a crucial feature that enhances communication, transparency, and responsiveness within the API management processes. By providing timely alerts and updates, stakeholders can effectively manage their APIs and subscriptions, leading to improved efficiency and productivity. Regularly checking and responding to notifications is important to stay informed and to ensure smooth API management operations.












2 changes: 2 additions & 0 deletions en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,8 @@ nav:
- Add an API State Change Workflow: design/advanced-topics/adding-an-api-state-change-workflow.md
- Block Subscription to an API: design/advanced-topics/block-subscription-to-an-api.md
- Validate API Definitions with Linters: design/advanced-topics/validate-api-definitions-with-linters.md
- Notifications:
- Overview: design/advanced-topics/notifications/notifications-overview.md
- Deploy and Publish APIs:
- Deploy on Gateway:
- Deploy API:
Expand Down