Notification Management Microservice
  • Dark
    Light
  • PDF

Notification Management Microservice

  • Dark
    Light
  • PDF

Setup notifications based on a pre-defined set of templates using these APIs which are crucial to alerting for an account holder as well as logging a past history of Notifications​.


APIs

fetchTemplates

The purpose of the fetchTemplates API is to fetch the notification template by the query parameter.

getAccountUINotifications

The purpose of the getAccountUINotifications API is to fetch the list of templates for the account.

getExternalCampaigns

The purpose of the getExternalCampaigns API is to fetch the list of templates for the account.

getNotificationAttachments

The purpose of the getNotificationAttachments API is to retrieve the notification attachments by ID.

getNotificationHistory

The purpose of the getNotificationHistory API is to retrieve the notification history and supports the following filters:

  • Channel (Email, SMS, UI)
  • NotificationType (Payment, Ordering, and so on)
  • Status (Scheduled, Success, Failed, and so on)
  • Created Date (Before, After, or Between range)
  • Status Date (Before, After, or Between range)

notificationTemplateById

The purpose of the notificationTemplateById API is to fetch the single template document file.

queueExternalNotificationTriggers

The purpose of the queueExternalNotificationTriggers API is to insert an external notification trigger in the notification queue.

retrieveHistoryFilters

The purpose of the retrieveHistoryFilters API is to retrieve the notification filters from an account's notification history.

sendNotification

The purpose of the sendNotification API is to send a notification to an account.

updateMessageStatus

The purpose of the updateMessageStatus API is to update the UI notification status.

Discover how we can help your Business

Get in touch with us today


Was this article helpful?