Skip to content

Commit a171a71

Browse files
committed
Update README.md
1 parent 6a3b882 commit a171a71

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,10 @@ alert.notify({
106106
});
107107
```
108108

109-
#### **Custom Notifications**
109+
#### Custom Notifications
110110
You can use these two signature to send the custom notification with pre-defined notification types.
111111

112-
##### **Passing the whole notification object**
112+
#### Passing the whole notification object
113113
By using this approach you need to pass the whole notification object as described in the API documentation
114114
```js
115115
alert.notify({
@@ -136,11 +136,11 @@ alert.notify({
136136
});
137137
```
138138

139-
##### **Passing the notification object in parts**
139+
#### Passing the notification object in parts
140140
By using this approach you can post a notification by providing different parts of the notification object grouped in related units
141141
```js
142142
alert.notify({
143-
recipients: recipients,
143+
144144
type: "IncidentCreated"
145145
priority: 'NEUTRAL',
146146
properties: [
@@ -184,12 +184,12 @@ alert.notify({
184184
```
185185

186186
Possible parameters:
187-
* **recipients** - List of the recipients
188-
* **type** - Notification type key
189-
* **priority** - Priority of the notification
190-
* **properties** - A key-value pair that is used to fill a placeholder of the notification type template
191-
* **navigation** - All navigation related parameters
192-
* **payload** - The rest parameters that can be passed
187+
* **recipients** - List of the recipients, this argument is mandatory
188+
* **type** - Notification type key, this argument is mandatory
189+
* **priority** - Priority of the notification, this argument is optional, it defaults to NEUTRAL
190+
* **properties** - A key-value pair that is used to fill a placeholder of the notification type template, this argument is optional
191+
* **navigation** - All navigation related parameters, this argument is optional
192+
* **payload** - The rest parameters that can be passed, this argument is optional
193193

194194
### Sample Application with notifications
195195

0 commit comments

Comments
 (0)