notification

Delivers user notifications including stream and read/progress controls.

Source path: libraries/core/src/notification

Module file: notification.module.ts

Introduction

This page documents the notification submodule as part of the Core package. Use it as a quick technical reference for implementation scope, exposed APIs and MCP integration points.

HTTP Endpoints

9 endpoints

List notifications for the current user.

Query: page, pageSize

Open a server-sent events stream to receive notifications in real time.

Return the number of unread notifications for the current user.

Create and dispatch a notification to a user.

Body

Field	Type	Required	Notes
user_id	number	yes	—
title	string	yes	—
body	string	no	—
icon	string	no	—
type	"info" \| "success" \| "warning" \| "error" \| "progress"	no	—
action_type	"url" \| "sheet" \| "modal"	no	—
action_url	string	no	—
action_data	object	no	—
auto_remove	boolean	no	—
progress	number	no	0–100
started_at	string	no	ISO 8601 date string

Mark all notifications of the current user as read.

Mark a single notification as read.

Params: id (int)

Update the progress value of a progress-type notification.

Params: id (int)

Body

Field	Type	Required	Notes
progress	number	yes	0–100
body	string	no	Updated message text
success	boolean	no	—

Delete all notifications for the current user.

Delete a specific notification.

Params: id (int)

MCP Tools

Named tools callable by AI models via the Model Context Protocol (MCP).

core.notifications.list
List notifications for the current user with pagination
core.notifications.unread-count
Return the number of unread notifications for the current user
core.notifications.mark-read
Mark a single notification as read
core.notifications.mark-all-read
Mark all notifications of the current user as read
core.notifications.create
Create and dispatch a notification to a user
core.notifications.delete
Delete a specific notification
core.notifications.delete-all
Delete all notifications for the current user
core.notifications.update-progress
Update the progress value of a progress-type notification