Skip to content

Commit 1d91f20

Browse files
docs(): Add docs for notifications and mx record
1 parent 3f00892 commit 1d91f20

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

+41
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@ composer require unicodeveloper/novu
2828
* [Topics](#topics)
2929
* [Activity](#activity)
3030
* [Integrations](#integrations)
31+
* [Notifications](#notifications)
3132
* [Notification Templates](#notification-templates)
3233
* [Notification Groups](#notification-groups)
3334
* [Changes](#changes)
3435
* [Environments](#environments)
3536
* [Feeds](#feeds)
3637
* [Messages](#messages)
3738
* [Execution Details](#execution-details)
39+
* [Validate the MX Record setup for Inbound Parse functionality](#validate-the-mx-record-setup-for-inbound-parse-functionality)
3840
* [License](#license)
3941

4042
## Usage
@@ -270,6 +272,36 @@ $novu->deleteIntegration($integrationId);
270272

271273
```
272274

275+
## NOTIFICATIONS
276+
277+
```php
278+
279+
// Get all notifications
280+
$novu->getNotifications()->toArray();
281+
282+
// Get all notifications with query parameters
283+
$queryParams = [
284+
'page' => 3
285+
];
286+
$novu->getNotifications($queryParams)->toArray();
287+
288+
// Get one notification
289+
$novu->getNotification($notificationId)->toArray();
290+
291+
// Get notification stats
292+
$novu->getNotificationStats()->toArray();
293+
294+
// Get Notification graph stats
295+
$novu->getNotificationGraphStats()->toArray();
296+
297+
// Get Notification graph stats with query parameters
298+
$queryParams = [
299+
'days' => 5
300+
];
301+
$novu->getNotificationGraphStats($queryParams)->toArray();
302+
303+
```
304+
273305
## NOTIFICATION TEMPLATES
274306

275307
```php
@@ -428,6 +460,15 @@ $novu->getExecutionDetails([
428460

429461
```
430462

463+
## Validate the MX Record setup for Inbound Parse functionality
464+
465+
```php
466+
467+
// Validate MX Record for Inbound Parse
468+
$novu->validateMXRecordForInboundParse()->toArray();
469+
470+
```
471+
431472
## License
432473

433474
**Novu PHP SDK** was created by **[Prosper Otemuyiwa](https://twitter.com/unicodeveloper)** under the **[MIT license](https://opensource.org/licenses/MIT)**.

0 commit comments

Comments
 (0)