Skip to main content

Mark as Read

Marking notifications as read in Nexla allows you to track which alerts have been reviewed and addressed, helping you maintain organized notification management and ensuring no critical issues are overlooked.

Status Management Overview​

Notification status management is essential for effective operational monitoring, allowing you to distinguish between new alerts that require attention and those that have already been reviewed and addressed.

Mark Notifications as Read​

Update notification status to indicate they have been reviewed and addressed.

Mark as Read Endpoint​

To mark a notification as read:

PUT /notifications/{notification_id}/read
Mark as Read: Request
PUT /notifications/5007/read

Mark as Read Response​

A successful mark as read operation returns the updated notification:

Mark as Read: Response
{
  "id": 5007,
  "owner": {
    "id": 42,
    "full_name": "John Smith",
    "email": "john.smith@example.com"
  },
  "org": {
    "id": 101,
    "name": "Acme Corporation",
    "email_domain": "acme.com"
  },
  "access_roles": ["owner"],
  "level": "INFO",
  "resource_id": 1002,
  "resource_type": "SOURCE",
  "message_id": 0,
  "message": "Data source connected successfully",
  "read_at": "2023-01-15T22:15:30.000Z",
  "updated_at": "2023-01-15T22:15:30.000Z",
  "created_at": "2023-01-15T21:04:48.000Z"
}

Mark Notifications as Unread​

Mark notifications as unread for later review or to highlight them for team attention.

Mark as Unread Endpoint​

To mark a notification as unread:

PUT /notifications/{notification_id}/unread
Mark as Unread: Request
PUT /notifications/5007/unread

Mark as Unread Response​

A successful mark as unread operation returns the updated notification:

Mark as Unread: Response
{
  "id": 5007,
  "owner": {
    "id": 42,
    "full_name": "John Smith",
    "email": "john.smith@example.com"
  },
  "org": {
    "id": 101,
    "name": "Acme Corporation",
    "email_domain": "acme.com"
  },
  "access_roles": ["owner"],
  "level": "INFO",
  "resource_id": 1002,
  "resource_type": "SOURCE",
  "message_id": 0,
  "message": "Data source connected successfully",
  "read_at": null,
  "updated_at": "2023-01-15T22:20:15.000Z",
  "created_at": "2023-01-15T21:04:48.000Z"
}

Bulk Status Operations​

Perform status updates on multiple notifications simultaneously for efficient management.

Bulk Mark as Read​

Mark multiple notifications as read in a single operation:

PUT /notifications/bulk_read
Bulk Mark as Read: Request
PUT /notifications/bulk_read

{
  "notification_ids": [5007, 5008, 5009],
  "read": true
}

Bulk Mark as Unread​

Mark multiple notifications as unread for later review:

Bulk Mark as Unread: Request
PUT /notifications/bulk_read

{
  "notification_ids": [5007, 5008, 5009],
  "read": false
}

Bulk Response​

Bulk operations return confirmation of the status updates:

Bulk Status Update: Response
{
  "status": "success",
  "message": "Notifications updated successfully",
  "updated_count": 3,
  "notifications": [
    {
      "id": 5007,
      "read_at": "2023-01-15T22:25:00.000Z"
    },
    {
      "id": 5008,
      "read_at": "2023-01-15T22:25:00.000Z"
    },
    {
      "id": 5009,
      "read_at": "2023-01-15T22:25:00.000Z"
    }
  ]
}

Status Management Benefits​

Understanding the benefits of notification status management helps you implement effective monitoring workflows.

Operational Efficiency​

Status management improves operational efficiency:

  • Clear Prioritization: Easily identify unread alerts requiring attention
  • Progress Tracking: Track which issues have been reviewed and addressed
  • Team Coordination: Coordinate responses across team members
  • Workload Management: Distribute notification review workload effectively

Compliance and Auditing​

Status management supports compliance and auditing requirements:

  • Response Tracking: Document when issues were reviewed and addressed
  • Audit Trails: Maintain complete records of notification handling
  • Compliance Reporting: Generate reports for regulatory requirements
  • Performance Metrics: Track response times and resolution rates

Status Management Workflows​

Implement effective workflows for managing notification status.

Individual Review Workflow​

Standard workflow for individual notification review:

  1. Receive Notification: System generates notification for event
  2. Review Content: User reviews notification message and details
  3. Assess Priority: Determine urgency and required response
  4. Take Action: Implement appropriate response or escalation
  5. Mark as Read: Update status to indicate completion

Team Review Workflow​

Workflow for team-based notification management:

  1. Initial Review: First responder reviews and assesses notification
  2. Team Assignment: Assign to appropriate team member if needed
  3. Response Implementation: Implement required response or fix
  4. Verification: Verify that issue has been resolved
  5. Status Update: Mark notification as read upon completion

Escalation Workflow​

Workflow for escalating critical notifications:

  1. Critical Assessment: Identify notifications requiring escalation
  2. Escalation Decision: Determine appropriate escalation level
  3. Team Notification: Alert appropriate team members
  4. Response Coordination: Coordinate response across team
  5. Resolution Tracking: Track resolution progress and completion

Status Management Best Practices​

To effectively manage notification status:

  1. Regular Review: Periodically review and update notification status
  2. Consistent Workflow: Implement consistent status management procedures
  3. Team Coordination: Coordinate status updates across team members
  4. Documentation: Maintain records of responses and resolutions
  5. Performance Monitoring: Track response times and resolution rates

Status Field Details​

Understanding the status field helps you manage notifications effectively.

Read Status Field​

The read_at field indicates notification status:

  • null: Notification is unread and requires attention
  • Timestamp: When the notification was marked as read
  • Format: ISO 8601 timestamp format (e.g., "2023-01-15T22:15:30.000Z")

Status Update Behavior​

Status updates follow specific behavior patterns:

  • Mark as Read: Sets read_at to current timestamp
  • Mark as Unread: Clears read_at field (sets to null)
  • Update Tracking: updated_at field reflects status change time
  • Audit Trail: Status changes are tracked in audit logs

Error Handling​

Common status management issues and solutions:

  • Permission Denied: Ensure you have appropriate access rights
  • Notification Not Found: Verify the notification ID exists
  • Invalid Status: Check that status values are correctly formatted
  • Bulk Operation Issues: Verify notification IDs in bulk operations

After managing notification status, you may need to:

List Notifications​

GET /notifications?read=0
GET /notifications?read=1

Get Notification Counts​

GET /notifications/count?read=0
GET /notifications/count?read=1

Delete Notifications​

DELETE /notifications/{notification_id}

View Notification Details​

GET /notifications/{notification_id}