Notifications API

The Notifications API provides endpoints for managing user notifications, including viewing, marking as read, and deleting notifications.

Overview

Nuclom has a comprehensive notification system that supports both in-app notifications and email notifications. Notifications are automatically created when:

Comment Events

• Someone replies to your comment
• Someone comments on your video
• You are @mentioned in a comment

Video Events

• A video is shared with you
• Your video processing is complete
• Your video processing fails

Organization Events

• You receive an invitation to join an organization

Billing Events

• Your trial is ending soon
• Your subscription is created
• Your subscription is updated
• Your subscription is canceled
• A payment succeeds
• A payment fails

Email Notifications

Email notifications are automatically sent alongside in-app notifications for important events. Emails include styled HTML templates with action buttons. You can configure the sender email address using the RESEND_FROM_EMAIL environment variable.

Endpoints

List Notifications

Retrieves all notifications for the authenticated user.

GET /api/notifications
Authorization: Bearer {token}

Query Parameters

Response

{
  "success": true,
  "data": {
    "data": [
      {
        "id": "notification-uuid",
        "userId": "user-uuid",
        "type": "comment_reply",
        "title": "New reply to your comment",
        "body": "John Doe replied to your comment",
        "resourceType": "video",
        "resourceId": "video-uuid",
        "actorId": "actor-user-uuid",
        "read": false,
        "createdAt": "2025-01-01T12:00:00Z",
        "actor": {
          "id": "actor-user-uuid",
          "name": "John Doe",
          "image": "https://example.com/avatar.jpg"
        }
      }
    ],
    "unreadCount": 5
  }
}

Mark All as Read

Marks all notifications as read for the authenticated user.

POST /api/notifications
Authorization: Bearer {token}

Response

{
  "success": true,
  "data": {
    "markedAsRead": 5
  }
}

Mark Single as Read

Marks a specific notification as read.

PATCH /api/notifications/{notificationId}
Authorization: Bearer {token}

Response

{
  "success": true,
  "data": {
    "id": "notification-uuid",
    "userId": "user-uuid",
    "type": "comment_reply",
    "title": "New reply to your comment",
    "body": "John Doe replied to your comment",
    "resourceType": "video",
    "resourceId": "video-uuid",
    "actorId": "actor-user-uuid",
    "read": true,
    "createdAt": "2025-01-01T12:00:00Z"
  }
}

Delete Notification

Deletes a specific notification.

DELETE /api/notifications/{notificationId}
Authorization: Bearer {token}

Response

{
  "success": true,
  "data": {
    "message": "Notification deleted successfully",
    "id": "notification-uuid"
  }
}

Notification Types

Notification Object

Error Responses

401 Unauthorized

{
  "success": false,
  "error": "Unauthorized"
}

404 Not Found

{
  "success": false,
  "error": "Notification not found"
}

---

See Also:

• Comments API
• Collaboration Guide