The notification infrastructure is in place for all channels listed below, but
individual channel readiness may vary. Verify each channel with the test
endpoint before relying on it in production.
Available channels
AI Review includes implementations for the following notification channels:
| Channel | Identifier |
|---|
| Email | email |
| Slack | slack |
| Webhook | webhook |
| DingTalk | dingtalk |
| Feishu | feishu |
| WeChat | wechat |
| Browser Push | push |
Retrieve current configuration
GET /api/notifications/config
Create or replace configuration
POST /api/notifications/config
Content-Type: application/json
| Field | Type | Description |
|---|
channels | string[] | List of enabled channel identifiers |
emailEnabled | boolean | Enable or disable email notifications |
slackWebhookUrl | string (URL) | Incoming webhook URL for Slack |
dingtalkWebhookUrl | string (URL) | Incoming webhook URL for DingTalk |
feishuWebhookUrl | string (URL) | Incoming webhook URL for Feishu |
Partial update
PATCH /api/notifications/config
Content-Type: application/json
POST but only updates the supplied keys.
Channel configuration
Slack
DingTalk
Feishu
Email
Webhook
Browser Push
Set slackWebhookUrl to your Slack incoming webhook URL and include
"slack" in the channels array:{
"channels": ["slack"],
"slackWebhookUrl": "https://hooks.slack.com/services/..."
}
Set dingtalkWebhookUrl to your DingTalk custom robot webhook URL and
include "dingtalk" in the channels array:{
"channels": ["dingtalk"],
"dingtalkWebhookUrl": "https://oapi.dingtalk.com/robot/send?access_token=..."
}
Set feishuWebhookUrl to your Feishu bot webhook URL and include
"feishu" in the channels array:{
"channels": ["feishu"],
"feishuWebhookUrl": "https://open.feishu.cn/open-apis/bot/v2/hook/..."
}
Enable email notifications by setting emailEnabled to true and
including "email" in the channels array:{
"channels": ["email"],
"emailEnabled": true
}
Include "webhook" in the channels array. Webhook delivery is handled
by the notification manager using the global webhook base URL configured
via the WEBHOOK_BASE_URL environment variable.{
"channels": ["webhook"]
}
Include "push" in the channels array. Browser Push requires VAPID keys
to be generated first — see Push notifications below. Test a channel
Before relying on a channel, send a test notification:
POST /api/notifications/config/test-channel
Content-Type: application/json
{
"channel": "slack"
}
channel: email, webhook, slack, wechat, dingtalk,
feishu, push.
The response contains a result field with the outcome from the notification
manager.
Push notifications
Browser Push notifications use the Web Push protocol and require a VAPID key
pair.
Generate VAPID keys
POST /api/notifications/config/generate-vapid-keys
{
"data": {
"keys": {
"publicKey": "...",
"privateKey": "..."
}
}
}
Manage subscriptions
| Method | Path | Description |
|---|
POST | /api/notifications/push/subscribe | Register a new push subscription |
GET | /api/notifications/push/subscriptions | List all push subscriptions |
GET | /api/notifications/push/users/:userId | List subscriptions for a user |
POST | /api/notifications/push/touch | Update last-used time for a subscription |
DELETE | /api/notifications/push/unsubscribe | Remove a push subscription |
POST | /api/notifications/push/clean | Delete all expired push subscriptions |
POST /push/subscribe) requires:
{
"endpoint": "https://...",
"keys": { ... },
"userId": "optional-user-id",
"userAgent": "optional-user-agent"
}
The browser-side push management UI is available under the Notifications
section in the dashboard. Enable push in your browser settings before
subscribing.
Notification history
List notifications
Supports query parameters for filtering and pagination:
| Parameter | Type | Description |
|---|
page | number | Page number (default: 1) |
pageSize | number | Items per page (default: 10) |
channel | string | Filter by channel identifier |
status | string | Filter by status |
notificationType | string | Filter by notification type |
reviewId | string | Filter by associated review ID |
startDate | string | ISO 8601 start date for range filter |
endDate | string | ISO 8601 end date for range filter |
Get notification detail
GET /api/notifications/history/:id
Get statistics
GET /api/notifications/stats
startDate and endDate query parameters. Returns aggregate
stats for the specified period.
Pending and failed notifications
GET /api/notifications/pending
GET /api/notifications/failed
PATCH /api/notifications/history/:id to update status and retry as needed.
Clean old notifications
POST /api/notifications/clean
Content-Type: application/json
{ "days": 30 }