Topic Console Guide
This page provides a complete guide to using the Topic section of the Namirasoft Notification Sender Console. It walks you through how to create and manage Topics, which act as central routing points for receiving alerts and updates from supported Namirasoft applications such as Namirasoft Bill Watch and Namirasoft Alarm. Topics allow for clean separation between message origin and delivery.
What Is a Topic?
A Topic is a logical channel that receives messages from supported Namirasoft apps. These messages are not delivered directly by the Topic; instead, the Topic passes them to one or more Subscribers, which then route them to your configured delivery services. Each Topic is identified by a unique name and can optionally include descriptive metadata to help organize your notification workflow.
Topics are lightweight entities but critical in defining how alerts and system-generated messages flow through the notification architecture.
Why Topics Matter
Topics help you organize and centralize notifications by grouping related messages under a shared name. This structure is especially useful when managing high-volume alerts across multiple applications. It also decouples the message source from the delivery mechanism, improving modularity, scalability, and control. You can later attach or remove Subscribers without affecting the apps that generate messages.
How Namirasoft Notification Sender Uses Topics
Namirasoft Notification Sender listens for messages on each active Topic. When a Namirasoft app (like Namirasoft Bill Watch) sends a message to a Topic, Namirasoft Notification Sender retrieves the message and forwards it to all Subscribers linked to that Topic. Each Subscriber handles the final delivery to a specified channel, allowing for parallel delivery to different users, teams, or services.
Overview of Topic Fields and Options
This section explains each field and setting visible when creating or managing a Topic in the console. It helps you understand what each item does and how it affects the behavior and organization of your notification setup.
- ID (String): A unique identifier automatically assigned when the topic or subscriber is created. It is used internally by Namirasoft Notification Sender to reference the item in the system. Users cannot modify it.
- User ID (Namirasoft Account’s ID): This is the unique ID of the Namirasoft Account that created the Topic or Subscriber. It links the item to a specific user for access control and tracking but does not affect how notifications are sent or processed.
- Workspace ID (Namirasoft Workspace’s ID): This is the ID of the Namirasoft Workspace to which the Topic or Subscriber belongs. It ensures that the Topic or Subscriber is associated with the correct Workspace, allowing logical grouping within a project or team environment.
-
Topic ID (String): The unique identifier of the Topic this Subscriber is associated with. It links the Subscriber to the Topic they will receive notifications from.
- Session ID (String): This is a shared identifier for the send operation, grouping all related Topic-level and Subscriber-level entries under the same dispatch session.
- Name (string): This is the user-defined name of the Topic or Subscriber, used for display and identification in the console. It helps users recognize and manage items within their Workspace but does not influence how the system processes notifications.
- Description (string): This is an optional field where users can provide additional details or notes about the Topic or Subscriber. It serves as a reference for human understanding and does not affect system behavior or delivery logic.
- Limit (Yes/ No): It specifies whether the topic has a sending limit applied. When enabled, the system restricts how many notifications can be sent through this Topic within a defined time frame.
- Limit Count (Integer): This shows the maximum number of notifications allowed for the Topic during the active limit period. If the Topic reaches this number, further sends are blocked until the period resets.
- Limit Per Value (Integer): This one defines the numeric length of the limit period. It works in combination with Limit Per Unit to establish the time window in which the send limit applies.
- Limit Per Unit (Enum): It specifies the unit of time (such as seconds, minutes, hours, or days) used for the Topic’s limit period. Together with Limit Per Value, it controls the duration of the send restriction.
- Delay (Yes/ No): It indicates whether a delay is applied before notifications are sent through this Topic. When enabled, the system postpones delivery by a defined amount of time after sending a notification.
- Delay Value (Integer): It specifies the numeric value of the delay period. Used with Delay Unit, it determines how long the system waits before sending each notification.
- Delay Unit (Enum): It defines the unit of time (millisecond, second, or minute) for the delay period. Combined with Delay Value, it sets the total wait time before a notification is delivered.
- Title (String): The subject or headline used for the notification messages in this session.
- Message (String): The body content of the notification that was delivered (or attempted) during the session.
- Subscribers (Integer): This shows the number of active Subscribers currently linked to this Topic. These Subscribers receive any messages sent to the Topic.
- Ignored (Integer): This shows the number of messages received by the Topic that were not forwarded to any Subscriber, either because no Subscribers were attached or the message did not meet delivery conditions.
- Successful (Integer): This indicates the total number of messages that were successfully delivered by Topic.
- Failed (Integer): This is the number of delivery attempts from this Topic that failed.
- Created At (DateTime): Appears on Topics, Subscribers, and in both Sent Topic and Sent Subscriber reports to show when each configuration or send session began.
- Updated At (DateTime): Shows the date and time when a Topic or Subscriber was last modified.
- Finished At (DateTime): Shows the date and time when a send session completed.