[Feature] API Consumer Notifications

[msm1992]

Problem

Problem

• APIM currently offers a notification mechanism that operates through the database.
• APIM users might want to use different notification modes (ex: email, sms etc) and to support such requirements current design would require extensive modifications.

Solution

• Implement an extensible notification system following a pub-sub architecture.
• Continuation of https://github.com/wso2/api-manager/issues/2383

Affected Component

APIM

Version

4.4.0

Implementation

No response

Related Issues

No response

Suggested Labels

No response

[npamudika]

Consumer Notifications Scenarios Document - https://docs.google.com/document/d/1Hn6eb25000SZWEOsnDTsVf6e9aKFsmvKAwC2ljRLRtE/edit?usp=sharing

[npamudika]

AsyncAPI Definition Document - https://docs.google.com/document/d/1OHNWqiLt8w_oEfbvzxImMukCBEcOFYT_Ots0JHPAxvo/edit?usp=sharing

[npamudika]

Design Document - https://docs.google.com/document/d/1hVELgd-hkIIXBzIT6CGx58r4Jy0pBJ8Bz7Pzuiihvp0/edit?usp=sharing

[npamudika]

Can use the following as the WebSub Hub when testing the feature.

https://central.ballerina.io/ballerina/websubhub/1.11.0 https://github.com/ballerina-platform/module-ballerina-websubhub/tree/main/examples

[npamudika]

Sub Tasks -

• [x] Finalize the design
• [x] Finalize the list of operations to be used
• [ ] Do the async API definition
• [ ] Check and refactor the implementations for Notifications Pages (with the bell icon) in Publisher and DevPortal, Notifications retrieval from the DB, Rest API changes
• [ ] Do the UX design of the topic subscription page in the Admin portal
• [ ] Do the implementation for the event publishing from the portals
• [ ] Do the implementation for the DB WebSub Server to save the events to the DB
• [ ] Complete the implementation to cover the full flow (Subscribe to topics, publish event notifications to DB websub server when an event for APIs/applications/API products related operations occurs, save notifications to DB, send a Http request via the notifications page to DB websub server to retreive the events from the DB, send notifications to notifications page)
• [ ] Test the implementation for the default DB websub server
• [ ] Test the implementation with the Ballerina websub Hub
• [ ] Do the documentation
• [ ] Write tests