API Reference

This page lists the Notification service HTTP API and the optional client proxy routes exposed by Microtec.Notifications.Client.

Direct Service Endpoints

Base path examples assume the Notification service is hosted at:

https://notification-service.internal

Endpoint Families

Send Endpoints

Method	Path	Body	Response
POST	/api/v1/EmailNotifications/Send	EmailPayload	NotificationResult
POST	/api/v1/SmsNotifications/Send	SmsPayload	NotificationResult
POST	/api/v1/PushNotifications/Send	PushPayload	NotificationResult
POST	/api/v1/WhatsAppNotifications/Send	WhatsAppPayload	NotificationResult

NotificationResult contains:

• IsSuccess
• ErrorMessage
• NotificationId

ASP.NET Core route matching is case-insensitive by default, and the client package currently uses lowercase send paths.

Notification Center

Method	Path	Description
GET	/api/v1/NotificationCenter/GetNotificationCenter	Admin paged notification list.
GET	/api/v1/NotificationCenter/MyNotifications	Current user's paged notification list.
GET	/api/v1/NotificationCenter/Push	Current user's push notifications.
GET	/api/v1/NotificationCenter/Email	Current user's email notifications.
GET	/api/v1/NotificationCenter/Sms	Current user's SMS notifications.
GET	/api/v1/NotificationCenter/push/Summary	Push notification summary.
GET	/api/v1/NotificationCenter/push/{notificationId}	Push detail.
GET	/api/v1/NotificationCenter/email/{notificationId}	Email detail.
GET	/api/v1/NotificationCenter/sms/{notificationId}	SMS detail.
GET	/api/v1/NotificationCenter/unread-count	Current user's unread count.
POST	/api/v1/NotificationCenter/mark-as-read	Mark multiple notifications as read.
POST	/api/v1/NotificationCenter/{notificationId}/mark-as-read	Mark one notification as read.
DELETE	/api/v1/NotificationCenter/{notificationId}	Delete one notification.
POST	/api/v1/NotificationCenter/{notificationId}/retry	Retry a notification.

Common list filters:

• searchTerm
• channel
• isRead
• moduleId
• serviceId
• notificationSettingType
• dateFrom
• dateTo
• pageNumber
• pageSize
• sortBy
• sortColumn

Admin list also supports userIds.

Device Tokens

Method	Path	Description
POST	/api/v1/DeviceTokens/Register	Register or update current user's device token.
PUT	/api/v1/DeviceTokens/{tokenId}	Update token value.
GET	/api/v1/DeviceTokens/my-tokens	Get current user's active tokens.
GET	/api/v1/DeviceTokens/{tokenId}	Get one token.
DELETE	/api/v1/DeviceTokens/{tokenId}	Delete one token.
GET	/api/v1/DeviceTokens/by-application/{applicationTarget}	Get tokens by application target.
POST	/api/v1/DeviceTokens/Validate	Validate stored device tokens.

Register body:

{
  "token": "<device-token>",
  "platform": "Mobile",
  "applicationTarget": "ERP",
  "provider": "FCM",
  "deviceModel": "iPhone"
}

Channel Config

Method	Path	Description
GET	/api/v1/ChannelConfig	List channel configs. Supports name and channelType query filters.

Credentials

Method	Path	Provider
POST	/api/v1/Credentials/azure-graph	Add Azure Graph email config.
PUT	/api/v1/Credentials/azure-graph	Edit Azure Graph email config.
GET	/api/v1/Credentials/azure-graph/{id}	Get Azure Graph config.
DELETE	/api/v1/Credentials/azure-graph/{id}	Delete Azure Graph config.
POST	/api/v1/Credentials/Smtp	Add SMTP config.
PUT	/api/v1/Credentials/Smtp	Edit SMTP config.
GET	/api/v1/Credentials/Smtp/{id}	Get SMTP config.
DELETE	/api/v1/Credentials/Smtp/{id}	Delete SMTP config.
POST	/api/v1/Credentials/Fcm	Add FCM config.
PUT	/api/v1/Credentials/Fcm	Edit FCM config.
GET	/api/v1/Credentials/Fcm/{id}	Get FCM config.
DELETE	/api/v1/Credentials/Fcm/{id}	Delete FCM config.
POST	/api/v1/Credentials/generic-http-sms	Add Generic HTTP SMS config.
PUT	/api/v1/Credentials/generic-http-sms	Edit Generic HTTP SMS config.
GET	/api/v1/Credentials/generic-http-sms/{id}	Get Generic HTTP SMS config.
DELETE	/api/v1/Credentials/generic-http-sms/{id}	Delete Generic HTTP SMS config.
POST	/api/v1/Credentials/msegat-whatsapp	Add Msegat WhatsApp config.
PUT	/api/v1/Credentials/msegat-whatsapp	Edit Msegat WhatsApp config.
GET	/api/v1/Credentials/msegat-whatsapp/{id}	Get Msegat WhatsApp config.
DELETE	/api/v1/Credentials/msegat-whatsapp/{id}	Delete Msegat WhatsApp config.
PUT	/api/v1/Credentials/msegat-whatsapp/{id}/toggle-activation?isActive=true	Activate or deactivate Msegat WhatsApp config.

WhatsApp Templates

Method	Path	Description
POST	/api/v1/WhatsAppTemplates	Add local WhatsApp template.
PUT	/api/v1/WhatsAppTemplates	Edit local WhatsApp template.
DELETE	/api/v1/WhatsAppTemplates/{id}	Delete local WhatsApp template.
GET	/api/v1/WhatsAppTemplates/{id}	Get one template.
GET	/api/v1/WhatsAppTemplates	List templates.
POST	/api/v1/WhatsAppTemplates/Sync	Sync one template or all templates to T2.

WhatsApp Provisioning

Method	Path	Description
POST	/api/v1/credentials/msegat-whatsapp/provisioning/Start	Queue provisioning for the current subdomain.
GET	/api/v1/credentials/msegat-whatsapp/provisioning/Status	Get provisioning state.
POST	/api/v1/credentials/msegat-whatsapp/provisioning/Retry	Retry only when previous state failed.

Seed

Method	Path	Description
POST	/api/v1/Seed/Defaults	Seed notification defaults.

Admin Notifications

Method	Path	Description
GET	/api/v1/admin/notifications	Admin notification list.
GET	/api/v1/admin/notifications/{notificationId}Email	Admin email detail.
GET	/api/v1/admin/notifications/{notificationId}Sms	Admin SMS detail.
GET	/api/v1/admin/notifications/{notificationId}Push	Admin push detail.
POST	/api/v1/admin/notifications/{notificationId}Retry	Retry notification from admin route.

The current admin route templates concatenate the id and action without a slash. Keep clients aligned with the route template until the service route is changed deliberately.

Client Proxy Routes

When a consuming app calls AddNotificationsClient(...), the client package adds controllers under /api/v1/notifications by default.

Proxy area	Default route
My notifications	/api/v1/notifications/center/MyNotifications
Admin notification center	/api/v1/notifications/center/GetNotificationCenter
Push summary	/api/v1/notifications/center/summary
Unread count	/api/v1/notifications/center/unread-count
Device tokens	/api/v1/notifications/device-tokens/...
Channel config	/api/v1/notifications/channel-config
Credentials	/api/v1/notifications/credentials/...
WhatsApp provisioning	/api/v1/notifications/credentials/msegat-whatsapp/provisioning/...
Seed defaults	/api/v1/notifications/seed/defaults

These proxy controllers call the Notification service through typed clients. They are useful when a host application wants to expose notification settings or notification center APIs through its own authorization and gateway surface.