In-App Notifications

Sistem Frog Cloud mengirimkan berbagai notifikasi langsung ke dalam Dashboard Customer (seperti pengingat tagihan jatuh tempo, pemberitahuan tiket balasan dari Support, atau status pembuatan VM).

Aplikasi Frontend atau Mobile dapat menggunakan endpoint di bawah ini untuk menampilkan bel notifikasi (Notification Bell) beserta daftar isinya.

---

1. Mengambil Daftar Notifikasi

Endpoint ini digunakan untuk merender list atau dropdown notifikasi. Data mendukung paginasi.

Request

GET /api/notifications/all?limit=15&offset=0

Respons (200 OK):

{
  "data": [
    {
      "id": 1,
      "type": "invoice_reminder",
      "data": "{\"invoice_id\":\"INV-123\", \"amount\":150000}",
      "read_at": null,
      "created_at": "2026-05-06T10:00:00Z"
    }
  ],
  "total": 1
}

Tip Frontend: Jika atribut read_at bernilai null, pastikan untuk menampilkan titik merah (unread indicator) atau cetak tebal (bold) pada item list notifikasi tersebut. Isi dari atribut data bisa berupa JSON String atau Objek JSON, sehingga Frontend perlu melakukan parsing sesuai kebutuhan.

---

2. Menandai Notifikasi Telah Dibaca

Ketika pelanggan mengklik atau membuka salah satu notifikasi, Frontend wajib memanggil endpoint ini di latar belakang agar status notifikasi di server berubah menjadi sudah dibaca (Read).

Request

PATCH /api/notifications/{notification_id}/read

Respons (200 OK): Status notifikasi telah diperbarui di database dan tidak akan ditampilkan sebagai unread pada request selanjutnya.