This section provides the event and associated payload of the Notification microservice.
Event
| SL.# | NAME | DESCRIPTION | PUBLISH LOCATION | ROUTING KEY | DURABILITY | PAYLOAD TYPE |
|---|---|---|---|---|---|---|
| 1 | Notification Queue | Notification service can subscribe to the notification queue to which the other services can send the events. When an event is triggered (for example, when a user is created), it is pushed into the notification queue. Notification service listens to that event message. Based on the payload data, which contains collection ID and event name, either sendEmail or sendSms action will be triggered. | NA | true | NotificationQueue |
Payload Model
NotificationQueue
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
notification[].name | String | Holds the name of the notification. | USER_INVITEUSER |
notification[].recipients[].bccs[].email | String | Refers to the recipient's email address for the email notification. | xyz@xyz.com |
notification[].recipients[].bccs[].name | String | Indicates the name of the recipient. | xyz |
notification[].recipients[].ccs[].email | String | Refers to the recipient's email address for the email notification. | xyz@xyz.com |
notification[].recipients[].ccs[].name | String | Indicates the name of the recipient. | xyz |
notification[].recipients[].tos[].email | String | Refers to the recipient's email address for the email notification. | xyz@xyz.com |
notification[].recipients[].tos[].name | String | Indicates the name of the recipient. | xyz |
notification[].recipients[].phone | String | Refers to the recipient's phone number for the SMS notification. An SMS will be sent to this phone number. | 9876543210 |
notification[].recipients[].pushId | String | Indicates the push ID of iOS, which is used to create pop-up messages in the application. | hj7sdf67sqc9 |
notification[].recipients[].macros | HashMap | Contains a list of macro name and value pairs. The given values will be replaced for the macro names in the email template. |
Revision History
2019-06-10 | PLK – Minor copyedits.
2019-05-17 | Mary – Updated to a new table tool.
2019-04-11 | Ananthi – Content updated for April 2019 release.
2019-01-23 | PLK – Content uploaded.
