Notifications API Reference

This section describes the API endpoints for managing notifications, including audit logs, notification channels, messages, and templates.

1. Audit Logs

Feature: Manage audit logs for notifications

• List Audit Logs GET /api/v1/notifications/audit-logs
• Get Audit Log Details GET /api/v1/notifications/audit-logs/{logId}

2. Notification Channels

Feature: Manage notification channels for sending notifications

• Create Notification Channel POST /api/v1/notifications/channels
• Update Notification Channel PATCH /api/v1/notifications/channels/{channelId}
• Delete Notification Channel DELETE /api/v1/notifications/channels/{channelId}
• List Notification Channels GET /api/v1/notifications/channels
• Get Notification Channel Details GET /api/v1/notifications/channels/{channelId}
• Update Notification Channel Status PATCH /api/v1/notifications/channels/{channelId}/status
• List Notification Channel Types GET /api/v1/notifications/channels/registry-info/types
• Get Notification Channel Type Details GET /api/v1/notifications/channels/registry-info/types/{channelType}

3. Notification Messages

Feature: Manage notification messages

• List Notification Messages GET /api/v1/notifications/messages
• Get Notification Message Details GET /api/v1/notifications/messages/{messageId}

4. Notification Templates

Feature: Manage notification templates

• Create Notification Template POST /api/v1/notifications/templates
• Update Notification Template PATCH /api/v1/notifications/templates/{templateId}
• Delete Notification Template DELETE /api/v1/notifications/templates/{templateId}
• List Notification Templates GET /api/v1/notifications/templates
• Get Notification Template Details GET /api/v1/notifications/templates/{templateId}

---

Last updated on Mar-31, 2026 | Version 1.0.0