Notification

Overview

To provide clear and focused documentation, the container workflow has been divided into three dedicated articles.

This article specifically covers Notification, which focuses on managing channels, templates, and delivery status.

Dependencies with Other Modules

Basic Operations

Basic API URL: https://{domain}/{tenantPath}/{srp}

Operation	API	Description
Create Notification Channel	POST {Basic API URL}/api/v1/notifications/channels	Create Notification Channel
List Notification Channels	GET {Basic API URL}/api/v1/notifications/channels	List Notification Channels
Update Notification Channel	PATCH {Basic API URL}/api/v1/notifications/channels/{channelId}	Update Notification Channel
Delete Notification Channel	DELETE {Basic API URL}/api/v1/notifications/channels/{channelId}	Delete Notification Channel

Constraints & Limitations

General

• API access requires authentication with a valid token

Create

• config is required

channelType	Required Fields	Optional Fields
email	host, port (1-65535), username, password, senderEmail (email format)	senderName, secure
teams	url (URL format)	-
linemessage	accessToken, sendMode (push or multicast)	-
webhook	url (URL format), method (GET/POST/PUT/PATCH/DELETE), contentType (applicationJson/applicationFormUrlEncoded/textPlain)	-

Update

• isEnabled is boolean type, enable or disable the channel.
• commonSettings is common settings including timeout, retryAttempts, retryDelay.
• templateId is associated template with the channel.
• recipients is setting recipients for channel.

Advanced Features

Notification

Operation	API	Description
Get Notification Channel Detail	GET {Basic API URL}/api/v1/notifications/channels/{channelId}	Get Notification Channel Detail
Enable/Disable Notification Channels	PUT {Basic API URL}/api/v1/notifications/channels/{channelId}/status	Enable/Disable Notification Channels
Get Enable Notification Channel	GET {Basic API URL}/api/v1/notifications/channels/registry-info/types	Get Enable Notification Channel
Get Notification Channel Type Info	GET {Basic API URL}/api/v1/notifications/channels/type-info	Get Notification Channel Type Info
Get Notification Delivery Status	GET {Basic API URL}/api/v1/notifications/messages/{messageId}	Get Notification Delivery Status
Get Notification Delivery Status	GET {Basic API URL}/api/v1/notifications/messages	Get Notification Delivery Status

Template

Operation	API	Description
Create Template	POST {Basic API URL}/api/v1/notifications/templates	Create Template
List Templates	GET {Basic API URL}/api/v1/notifications/templates	List Templates
Get Template Detail	GET {Basic API URL}/api/v1/notifications/templates/{templateId}	Get Template Detail
Update Template	PATCH {Basic API URL}/api/v1/notifications/templates/{templateId}	Update Template
Delete Template	DELETE {Basic API URL}/api/v1/notifications/templates/{templateId}	Delete Template

---

Last updated on Apr-8, 2026 | Version 1.0.0