doc/api/notifications.md
Endpoints for managing notifications.
/notif/mark-ack (auth required)The /notif/mark-ack endpoint marks the specified notification
as "acknowledged". This indicates that the user has chosen to either
dismiss or act on this notification.
| Name | Description | Default Value |
|---|---|---|
| uid | UUID associated with the notification | required |
This endpoint responds with an empty object ({}).
/notif/mark-read (auth required)The /notif/mark-read endpoint marks that the specified notification
has been shown to the user. It will not "pop up" as a new notification
if they load the gui again.
| Name | Description | Default Value |
|---|---|---|
| uid | UUID associated with the notification | required |
This endpoint responds with an empty object ({}).
await fetch("https://api.puter.local/notif/mark-read", {
headers: {
"Content-Type": "application/json",
"Authorization": `Bearer ${puter.authToken}`,
},
body: JSON.stringify({
uid: 'a14ea3d5-828b-42f9-9613-35f43b0a3cb8',
}),
method: "POST",
});
puter-notificationsThe puter-notifications driver is an Entity Storage driver.
It is read-only.
await fetch("http://api.puter.localhost:4100/drivers/call", {
"headers": {
"Content-Type": "application/json",
"Authorization": `Bearer ${puter.authToken}`,
},
"body": JSON.stringify({
interface: 'puter-notifications',
method: 'select',
args: { predicate: ['unread'] }
}),
"method": "POST",
});
await fetch("http://api.puter.localhost:4100/drivers/call", {
"headers": {
"Content-Type": "application/json",
"Authorization": `Bearer ${puter.authToken}`,
},
"body": JSON.stringify({
interface: 'puter-notifications',
method: 'select',
args: {}
}),
"method": "POST",
});
await fetch("http://api.puter.localhost:4100/drivers/call", {
"headers": {
"Content-Type": "application/json",
"Authorization": `Bearer ${puter.authToken}`,
},
"body": JSON.stringify({
interface: 'puter-notifications',
method: 'select',
args: { offset: 200 }
}),
"method": "POST",
});