Skip to content

notifications preferences to user & task mute endpoints #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
interisti wants to merge 3 commits into
base: main
Choose a base branch
from
Open

notifications preferences to user & task mute endpoints #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f1d0023
#1133 add notification preferences to accounts spec
interisti Jun 10, 2026
0cd5ad2
#1133 add task mute/unmute endpoint specs in workspaces
interisti Jun 10, 2026
d0427eb
#1131 add user notifications endpoints
interisti Jun 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
321 changes: 321 additions & 0 deletions docs/api-reference/endpoint/accounts/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,6 +499,14 @@
"passkey_enabled": {
"type": "boolean",
"description": "Enable passkey authentication"
},
"notification_preferences": {
"allOf": [
{
"$ref": "#/components/schemas/NotificationPrefs"
}
],
"description": "User's notification preferences across all notification types and delivery channels."
}
}
},
Expand Down Expand Up @@ -1142,6 +1150,143 @@
"file",
"content_type"
]
},
"NotificationChannels": {
"type": "object",
"description": "Per-channel delivery toggles for a single notification type.",
"properties": {
"in_app": {
"type": "boolean",
"description": "Whether in-app notifications are delivered for this type.",
"example": true
},
"email": {
"type": "boolean",
"description": "Whether email notifications are delivered for this type.",
"example": false
},
"push": {
"type": "boolean",
"description": "Whether push notifications are delivered for this type.",
"example": true
}
},
"required": [
"in_app",
"email",
"push"
]
},
"NotificationTypePrefs": {
"type": "object",
"description": "Opt-in state and channel configuration for one notification type.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the user receives notifications of this type at all. When false, channel toggles are ignored.",
"example": true
},
"channels": {
"$ref": "#/components/schemas/NotificationChannels"
}
},
"required": [
"enabled",
"channels"
]
},
"NotificationQuietHours": {
"type": "object",
"description": "Time window during which notifications are suppressed. Times are interpreted in the configured timezone.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether quiet hours are active. When false, the time fields are ignored.",
"example": true
},
"start": {
"type": "string",
"description": "Start of the quiet window in 24-hour HH:MM format.",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
"example": "22:00"
},
"end": {
"type": "string",
"description": "End of the quiet window in 24-hour HH:MM format.",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
"example": "07:00"
},
"timezone": {
"type": "string",
"description": "IANA timezone name used to interpret the start and end times.",
"example": "Europe/London"
}
},
"required": [
"enabled",
"start",
"end",
"timezone"
]
},
"NotificationPrefs": {
"type": "object",
"description": "A user's global notification preferences across all notification types and delivery channels.",
"properties": {
"task_status_changes": {
"allOf": [
{
"$ref": "#/components/schemas/NotificationTypePrefs"
}
],
"description": "Preferences for notifications when a task's status changes."
},
"task_assignments": {
"allOf": [
{
"$ref": "#/components/schemas/NotificationTypePrefs"
}
],
"description": "Preferences for notifications when a task is assigned to the user."
},
"task_mentions": {
"allOf": [
{
"$ref": "#/components/schemas/NotificationTypePrefs"
}
],
"description": "Preferences for notifications when the user is mentioned on a task."
},
"task_watcher_updates": {
"allOf": [
{
"$ref": "#/components/schemas/NotificationTypePrefs"
}
],
"description": "Preferences for notifications about tasks the user is watching."
},
"batch_mode": {
"type": "string",
"description": "How email notifications are grouped before delivery. 'realtime' sends immediately; 'hourly' and 'daily' send digests.",
"enum": [
"realtime",
"hourly",
"daily"
],
"example": "daily"
},
"quiet_hours": {
"$ref": "#/components/schemas/NotificationQuietHours"
}
},
"required": [
"task_status_changes",
"task_assignments",
"task_mentions",
"task_watcher_updates",
"batch_mode",
"quiet_hours"
]
}
}
},
Expand Down Expand Up @@ -4227,6 +4372,9 @@
},
"profile_image": {
"$ref": "#/components/schemas/UserProfileImage"
},
"notification_preferences": {
"$ref": "#/components/schemas/NotificationPrefs"
}
},
"required": [
Expand Down Expand Up @@ -5658,6 +5806,179 @@
}
}
}
},
"/accounts/users/notifications": {
"get": {
"summary": "List user notifications",
"description": "Retrieves the list of notifications for the user",
"operationId": "listNotifications",
"tags": [
"User Management"
],
"x-resource-type": "service",
"x-resource": "microstrate.accounts.get.list-user-notifications",
"responses": {
"200": {
"description": "Notifications retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"created_at": {
"type": "string"
},
"viewed": {
"type": "boolean"
},
"refs": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"ref_id",
"type",
"url"
],
"properties": {
"label": {
"type": "string"
},
"ref_id": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "No Notifications found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/accounts/users/notifications/viewed": {
"patch": {
"summary": "Set user notification as viewed",
"description": "Updates status of the user notification as viewed",
"operationId": "patchNotificationViewed",
"tags": [
"User Management"
],
"x-resource-type": "service",
"x-resource": "microstrate.accounts.patch.user-notification-viewed",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"description": "Subject of the notificaiton"
}
},
"required": [
"subject"
]
}
}
}
},
"responses": {
"200": {
"description": "Notification successfully updated as viewed",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object"
}
}
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "No Notifications found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
}
}
}
Loading