Files
fizzy/docs/api/sections/notifications.md
T
Mike Dalessio e70047ca0f Default development environment to app.fizzy.localhost (#2822)
Using fizzy.localhost causes CORS errors when using minio for Active
Storage because the minio endpoint is at minio.fizzy.localhost — a
sibling subdomain, not a subdomain of the app host. Switching to
app.fizzy.localhost makes both hosts subdomains of fizzy.localhost,
resolving the CORS issue. See #2814 for the related minio CORS fix.

fizzy.localhost will continue to work if people want to use it, but all
docs and scripts have been updated to point to app.fizzy.localhost.
2026-04-09 12:43:01 -04:00

99 lines
2.3 KiB
Markdown

# Notifications
Notifications inform users about events that happened in the account, such as comments, assignments, and card updates.
## `GET /:account_slug/notifications`
Returns a list of notifications for the current user. Unread notifications are returned first, followed by read notifications.
__Response:__
```json
[
{
"id": "03f5va03bpuvkcjemcxl73ho2",
"read": false,
"read_at": null,
"created_at": "2025-11-19T04:03:58.000Z",
"title": "Plain text mentions",
"body": "Assigned to self",
"creator": {
"id": "03f5v9zjw7pz8717a4no1h8a7",
"name": "David Heinemeier Hansson",
"role": "owner",
"active": true,
"email_address": "david@example.com",
"created_at": "2025-12-05T19:36:35.401Z",
"url": "http://app.fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7"
},
"card": {
"id": "03f5v9zo9qlcwwpyc0ascnikz",
"title": "Plain text mentions",
"status": "published",
"url": "http://app.fizzy.localhost:3006/897362094/cards/3"
},
"url": "http://app.fizzy.localhost:3006/897362094/notifications/03f5va03bpuvkcjemcxl73ho2"
}
]
```
## `POST /:account_slug/notifications/:notification_id/reading`
Marks a notification as read.
__Response:__
Returns `204 No Content` on success.
## `DELETE /:account_slug/notifications/:notification_id/reading`
Marks a notification as unread.
__Response:__
Returns `204 No Content` on success.
## `POST /:account_slug/notifications/bulk_reading`
Marks all unread notifications as read.
__Response:__
Returns `204 No Content` on success.
## `GET /:account_slug/notifications/settings`
Returns the current user's notification settings.
__Response:__
```json
{
"bundle_email_frequency": "every_few_hours"
}
```
Possible values for `bundle_email_frequency`: `never`, `every_few_hours`, `daily`, `weekly`.
## `PUT /:account_slug/notifications/settings`
Updates the current user's notification settings.
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bundle_email_frequency` | string | Yes | How often to bundle notification emails. One of: `never`, `every_few_hours`, `daily`, `weekly` |
__Request:__
```json
{
"user_settings": {
"bundle_email_frequency": "daily"
}
}
```
__Response:__
Returns `204 No Content` on success.