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: and the data is sent as JSON.

Get user profile & notifications settings

This method returns the user profile with its preferences: which notifications he wants to mute or not, and the list of notifications definitions.


List messages

List messages for a given user, sent to the "widget" channel. The response contains the count of unread messages and the overall total.


Mark a message as read


Mark all messages as read


Set user preferences


Last updated