Frontend API
The frontend API is used by the widget to fetch the user profile, notifications settings and messages.
You might need to use it if you want to build your own widget, or list the users messages somewhere else out of the widget.
The frontend API endpoint is: https://api.notifuse.com/front/ and the data is sent as JSON.
This method returns the user profile with its preferences: which notifications he wants to mute or not, and the list of notifications definitions.
GET https://api.notifuse.com/front/users.get
Param | Type | Description |
| string REQUIRED | Project ID |
| string REQUIRED | User ID |
| string REQUIRED | HMAC256 of the |
{"user": {"id": "xxx","projectId": "your_project_id","language": "en","timezone": "Europe/London","preferences": {"notification_welcome": {"notificationId": "notification_welcome","muteWidget": false,"muteEmail": true,"muteSMS": false}},"firstName": "John","lastName": "Doe","photoURL": "https://...jpg","email": "[email protected]","telephone": "+44 7911 123456","createdAt": "2020-10-18T21:59:27.347Z","updatedAt": "2020-10-18T21:59:27.347Z"},"notifications": [{"id": "notification_welcome","projectId": "your_project_id","name": "Welcome","withWidget": true,"withEmail": true,"withSMS": true,"allowMuteWidget": true,"allowMuteEmail": false,"allowMuteSMS": true,"createdAt": "2020-10-18T21:59:27.347Z"},...]}
List messages for a given user, sent to the "widget" channel. The response contains the count of unread messages and the overall total.
GET https://api.notifuse.com/front/messages.list
Param | Type | Description |
| string REQUIRED | Project ID |
| string REQUIRED | User ID |
| string REQUIRED | HMAC256 of the |
| int | Number of messages to retrieve |
| int | Number of messages to skip |
{"messages": [{"id": "xxxxxxx","projectId": "your_project_id","notificationId": "welcome","userId": "xxx","data": {"a_payload_object": {},"another_variable: true,"a_number: 1234},"content": "The content displayed in the widget...","icon": "The widget icon URL","readAt": "2020-10-18T21:59:27.347Z","readFromChannel": "widget","stackId": "new_comments_xxxx","stackCounter": 21,"stackAt": "2020-10-18T21:59:27.347Z",},...],"total": 123,"unread": 123}
POST https://api.notifuse.com/front/messages.read
Param | Type | Description |
| string REQUIRED | Project ID |
| string REQUIRED | User ID |
| string REQUIRED | HMAC256 of the |
| string REQUIRED | Message ID |
{"code": 200}
POST https://api.notifuse.com/front/messages.readAll
Param | Type | Description |
| string REQUIRED | Project ID |
| string REQUIRED | User ID |
| string REQUIRED | HMAC256 of the |
{"code": 200}
POST https://api.notifuse.com/front/users.setProfile
Param | Type | Description |
| string REQUIRED | Project ID |
| string REQUIRED | User ID |
| string REQUIRED | HMAC256 of the |
| object REQUIRED | The user object with updated |
{"code": 200}
