2. API Interface — Novu Notification Hub

Toàn bộ hệ thống Novu giao tiếp thông qua RESTful API v1. Hệ thống đảm bảo tính Stateless, hỗ trợ JSON Payload đồng nhất trên mọi kênh.

I. Nguyên tắc Xác thực (API Keys)

Để gọi API từ Server-side, bạn cần đính kèm API Key (đã cấp trong Settings Dashboard) vào Header:

Header Name
Authorization

Format
ApiKey <YOUR_API_KEY>

II. Phân hệ Kích hoạt Sự kiện (Events Trigger)

API Trigger Sự kiện Thông báo

Đây là đầu nạp dữ liệu chính để gửi tin nhắn đến 1 hoặc nhiều người nhận cùng lúc.

Endpoint
POST /v1/events/trigger

Tham số Request Body

Tham số	Kiểu	Bắt buộc	Mô tả
`name`	`string`	Có	Tên Workflow đã tạo trên Dashboard
`to`	`object/array`	Có	Chứa `subscriberId` và các info bổ sung
`payload`	`object`	Không	Dữ liệu động để điền vào Template (Markup `{...}`)
`transactionId`	`string`	Không	Mã giao dịch tự định nghĩa để truy vết

Ví dụ Request

{
  "name": "onboarding-email",
  "to": {
    "subscriberId": "user_id_001",
    "email": "abc@example.com"
  },
  "payload": {
    "organization": "One Push Team",
    "user_name": "Nguyen Khang"
  }
}

III. Phân hệ Quản lý Subscribers

Đồng bộ User (Upsert)

Dùng để tạo mới hoặc cập nhật thông tin người dùng cuối.

Endpoint
POST /v1/subscribers

Tham số Request Body

Tham số	Kiểu	Bắt buộc	Mô tả
`subscriberId`	`string`	Có	ID duy nhất của User trong hệ thống của bạn
`firstName`	`string`	Không	Tên hiển thị của người dùng
`lastName`	`string`	Không	Họ hiển thị của người dùng
`email`	`string`	Không	Địa chỉ Email liên hệ
`phone`	`string`	Không	Số điện thoại nhận tin SMS

Dành cho ứng dụng Client-side (Frontend) truy xuất danh sách thông báo để hiển thị.

Endpoint
GET /v1/widgets/notifications/feed

Thực thi
Dùng thư viện @novu/notification-center để tự động hoá việc gọi API này. API trả về danh sách thông báo chưa đọc (Unread Feed) và tổng số lượng tin nhắn cho Dashboard.

API

2. API Interface — Novu Notification Hub#

I. Nguyên tắc Xác thực (API Keys)#

II. Phân hệ Kích hoạt Sự kiện (Events Trigger)#

API Trigger Sự kiện Thông báo#

III. Phân hệ Quản lý Subscribers#

Đồng bộ User (Upsert)#