Notifications

In-app notification system for users and organizations. Create, read, mark-as-read, and clear notifications via API.

List Notifications

GET /notificationsAuth Required

// Paginated list
GET /notifications?page=1&limit=20

// Response
{
  "notifications": [
    {
      "id": "notif_abc123",
      "title": "Function deployed",
      "message": "send-welcome was deployed successfully",
      "type": "success",
      "read": false,
      "created_at": "2026-03-24T10:30:00Z"
    }
  ],
  "total": 45,
  "page": 1
}

Unread Count

GET /notifications/count

// Response
{
  "unread": 5,
  "total": 45
}

Actions

Manage Notifications

// Mark one as read
PATCH /notifications/{notification_id}/read

// Mark all as read
PATCH /notifications/read-all

// Delete one
DELETE /notifications/{notification_id}

// Clear all
DELETE /notifications

Create Notification

System-level or admin-created notifications:

POST /notificationsAdmin

{
  "title": "Maintenance scheduled",
  "message": "Platform maintenance on March 25, 2AM UTC",
  "type": "info"
}

API Reference

Method	Path	Description
GET	/notifications	List notifications (paginated)
GET	/notifications/count	Unread count
POST	/notifications	Create notification
PATCH	/notifications/{id}/read	Mark as read
PATCH	/notifications/read-all	Mark all as read
DELETE	/notifications/{id}	Delete notification
DELETE	/notifications	Clear all