Notifications

Notifications inform users about activity relevant to them across their boards — invites, meeting and dashboard activity, report publication, and more. Notifications can be marked as read individually or in bulk, deleted, and each user can control which channels (email, in_app) a given event category delivers to.

Endpoints

Notification Object

{
  "_id": "60d5ec49f1a2c8b1f8e4e1a1",
  "userId": "507f1f77bcf86cd799439011",
  "type": "board_invite",
  "message": "You have been invited to join Acme Corp board.",
  "boardId": { "_id": "60d5ec49f1a2c8b1f8e4e1b1", "name": "Acme Corp Board" },
  "inviterId": {
    "_id": "507f1f77bcf86cd799439012",
    "firstName": "Alex",
    "lastName": "Admin"
  },
  "read": false,
  "avatar": "https://.../signed-s3-url",
  "createdAt": "2025-06-01T10:00:00.000Z",
  "updatedAt": "2025-06-01T10:00:00.000Z"
}

Fields

There is no single generic "resource ID" field. Depending on type, one or more of the following optional fields are present, and the list endpoint populates the referenced document into an object (as shown for boardId/inviterId above) rather than leaving it a bare ID string: boardId, inviterId, inviteId, acceptingUserId, triggeringUserId, meetingLink, reportId, dashboardId, dashboardType, documentId, cycleId, sectionName, betId. The list endpoint also computes an avatar field (a signed URL) from whichever user reference is relevant.

Type Values

board_invite, membership_accepted, membership_modified, membership_removed, member_left, board_update, new_comment, task_assignment, ownership_transfer, slot_proposed, dashboard_assigned, dashboard_access_granted, dashboard_access_removed, dashboard_changes_requested, dashboard_ready_for_review, dashboard_internally_reviewed, report_published, report_finalized, example_board_ready, merge_recommendation, meeting_creation_suggestion, section_dispatched, section_reminder, post_meeting_minutes_distributed, validation_flag_raised, package_published, bet_due_soon, meeting_rsvp_changed, meeting_updated_from_calendar, meeting_cancelled_from_calendar

List Notifications

GET /api/notification/

Returns all notifications for the authenticated user, ordered by most recent first, with related documents populated.

Response

Returns a bare array — not wrapped in { "data": ... }:

[
  /* array of notification objects */
]

Errors

Mark All Notifications as Read

PUT /api/notification/read/all

Response

{ "message": "All notifications for user marked as read" }

Errors

Mark a Single Notification as Read

PUT /api/notification/read/:notificationId

Response

Returns the updated notification object with read: true.

Errors

Delete a Notification

DELETE /api/notification/:notificationId

Deletes a notification. JWT-only — API tokens cannot call this endpoint.

Response

{ "message": "Notification deleted successfully" }

Errors

Get Notification Preferences

GET /api/notification/preferences

Returns only the categories the user has explicitly overridden — a category absent from the response is using its default channels.

Response

Bare object, not wrapped in { "data": ... }:

{
  "preferences": {
    "action_item": ["email", "in_app"],
    "bet_reminder": []
  }
}

preferences maps an event category to the list of channels (email, in_app) it delivers to. An empty array silences that category entirely.

Event Categories

section_status, validation_flag, package_status, post_meeting, action_item, bet_reminder, section_overdue

Errors

Update a Notification Preference

PUT /api/notification/preferences

Upserts the channel list for one event category.

Request Body

Response

Returns the full updated { "preferences": { ... } } map, in the same shape as the GET response.

Errors