notifkit
自託管產品通知基礎設施。一個 notify() 呼叫即可處理電子郵件、簡訊、推播等,內建偏好設定、靜音時段、重試、備援
notifkit 是什麼?
自託管產品通知基礎設施。一個 notify() 呼叫即可處理電子郵件、簡訊、推播等,內建偏好設定、靜音時段、重試、備援、排程、工作流程及傳遞記錄。
notifkit 概覽
這是什麼
notifkit 是一個自託管的產品通知基礎設施。它提供單一的 notify() API 呼叫,可處理電子郵件、簡訊、推播通知、聊天訊息和 Webhook。內建功能包括使用者偏好設定、靜音時段、重試、備援、排程、工作流程、管理儀表板和送達記錄。它運行在 PostgreSQL 和 Redis 上。本專案採用 MIT 授權,為開源軟體。
主要功能
- 單一 API 呼叫 (notify()) 支援多種頻道:推播、電子郵件、簡訊、聊天、Webhook。
- 內建使用者偏好、同意管理、靜音時段、重試、去重、節流、範本渲染和送達追蹤。
- 頻道備援:若某頻道失敗,自動嘗試下一個指定的頻道。
- 工作流程以 TypeScript 程式碼定義,支援多步驟序列,可等待數天、阻塞於事件。
- 管理儀表板提供即時活動饋送、送達記錄、佇列深度、工作流程執行步驟、死信重播、排程取消和 API 金鑰管理。
- MCP 伺服器可整合 AI 代理(例如 Claude Code、Cursor)。
- 支援多個專案,各自擁有獨立的 API 金鑰和資料。
使用情境
- 產品通知:訂單出貨、密碼重設、一次性密碼、行銷活動。
- 多頻道通知傳送並具備備援機制(例如先推播再電子郵件)。
- 排程與工作流程式通知(例如等待數天、阻塞於事件)。
- 自託管替代方案,取代 Knock 或 Courier 等託管服務,避免按訊息計費。
- 整合現有的 PostgreSQL 和 Redis 基礎設施。
快速開始
需要 Node 22+ 和 Docker。開發模式下 notifkit 會自動啟動暫時性的 PostgreSQL 和 Redis 容器。bashnpm create notifkit@latest my-app # 或:npx notifkit create my-appcd my-appnpm run dev # 保持執行在另一個終端機中:bashnpm run setup # 建立專案,將 API 金鑰儲存至 .envnpm run send # 傳送測試通知預設提供者會將通知列印至伺服器終端機,因此無需提供者帳號即可試用。傳遞 --provider resend、twilio 或 fcm 即可開始使用真實提供者。### 授權
內容整理自該專案公開的 README 與儲存庫資訊。