API Integration
Instructions on how to build the API integration for Inbox/On-Site Messages.
⬇️ GET /Notifications/v2/user-notifications?{filters}
Lists all notifications for an authenticated user. Use the query string parameters to filter notifications:
Key | Values | Description |
---|---|---|
Key | Values | Description |
unread-only | true / false | Only return unread notifications |
Response
⬇️ GET /Notifications/v2/user-notification/:ID
It returns notification for the given id
Response
❌ DELETE /Notifications/v2/user-notification/:ID
This marks specific notification as deleted. Deleted notifications won't be returned in endpoint for getting all notifications or endpoint for getting a specific notification.
Response
⤴️ POST /Notifications/MarkNotificationAsRead
This marks notification as read. Be aware this is a POST request. You have to provide a post body looking like the following.
Request
Response