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 |
unread-only | true / false | Only return unread notifications |
Response
{"Data": [{"MessageId": 123,"UserId": 123,"Event": "message","Title": "Title","Message": "<div>This is message body</div>", // Can contain HTML"PreviewText": "Preview text", // Cannot contain HTML"FooterText": "<div>This is footer text</div>", // Can contain HTML"Data": {}, // Extra fields for your usage"CTAButtonLink": "https://www.example.com","CTAButtonText": "Click here!","CTAButton2Link": "https://www.example.com","CTAButton2Text": "Read more!","ImageUrl": "https://www.example.com/image.jpg","IsRead": true,"Date": "2019-02-14 13:07:00","Expires": "2019-12-12 12:00:00"},...],"Success": true,"Errors": []}
⬇️ GET /Notifications/v2/user-notification/:ID
It returns notification for the given id
Response
{"Data": {"MessageId": 123,"UserId": 123,"Event": "message","Title": "Title","Message": "<div>This is message body</div>", // Can contain HTML"PreviewText": "Preview text", // Cannot contain HTML"FooterText": "<div>This is footer text</div>", // Can contain HTML"Data": {}, // Extra fields for your usage"CTAButtonLink": "https://www.example.com","CTAButtonText": "Click here!","CTAButton2Link": "https://www.example.com","CTAButton2Text": "Read more!","ImageUrl": "https://www.example.com/image.jpg","IsRead": true,"Date": "2019-02-14 13:07:00","Expires": "2019-12-12 12:00:00"},"Success": true,"Errors": []}
❌ 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
{"Data": null,"Success": true,"Errors": []}
⤴️ 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
{"MessageId": 123}
Response
{"Data": true,"Success": true,"Errors": []}