alertmanagement
The module nodes are the building blocks for the flow-based programming. Each node represents a specific task or operation that can be performed by the module. The following table lists the available nodes for this module.
Fire Email Alert
Section titled “Fire Email Alert”Send an alert via email to notify the user with important information.
Metadata:
Section titled “Metadata:”- Name: AlertEmail
- Tags: alert, email, fire, notification, communication
- Category: Action
- Subcategory: Notification > Email
Description:
Section titled “Description:”This node triggers an email alert to notify a user with specified alert data. It requires configuration through the NodeAlertEmailConfig to set up the email server, recipient details, and other email-related settings. This node is useful for sending automated alerts, notifications, or critical updates to users, making it an essential component in monitoring, system health alerts, or any scenario where email-based communication is needed. The alert data is passed into the node and sent via email, with the result of the operation being output to indicate whether the email was successfully sent.
Inputs: (1)
- Email Data : The alert data to be sent via email, containing relevant information such as the subject, message, and additional details.
Outputs: (1)
Section titled “Outputs: (1)”- Is Success : Success
Configuration:
Section titled “Configuration:”The following configuration parameters can be set for this node:
NodeAlertEmailConfig: {
# The email address from which the alert is sent. from: string, # The email address to which the alert is sent. to: string, # The domain name of the email. domain: string, # The Mailgun API key. apikey: string, # The default title of the email. title: string,}Fire Slack Alert
Section titled “Fire Slack Alert”Send an alert to Slack to notify users with important information.
Metadata:
Section titled “Metadata:”- Name: AlertSlack
- Tags: alert, slack, fire, notification, communication
- Category: Action
- Subcategory: Notification > Slack
Description:
Section titled “Description:”This node sends an alert message to a Slack channel, notifying users with the provided alert data. It requires configuration via NodeAlertSlackConfig, where details such as the Slack webhook URL or authentication tokens are set. This node is particularly useful for sending automated notifications, warnings, or critical updates to Slack channels, making it a key component for communication in collaborative environments. The alert data, which includes the message content and other details, is passed into the node and sent to the specified Slack workspace. The output indicates whether the alert was successfully delivered.
Inputs: (1)
- Slack Data : The alert data to be sent to Slack, which includes the message content, channel, and any additional metadata required for the notification.
Outputs: (1)
Section titled “Outputs: (1)”- Is Success : Success
Configuration:
Section titled “Configuration:”The following configuration parameters can be set for this node:
NodeAlertSlackConfig: {
# The API token for authenticating with Slack. apitoken: string, # The ID of the Slack channel where alerts will be sent. channelid: string,}Fire Telegram Alert
Section titled “Fire Telegram Alert”Send an alert to Telegram to notify users with important information.
Metadata:
Section titled “Metadata:”- Name: AlertTelegram
- Tags: alert, telegram, fire, notification, communication
- Category: Action
- Subcategory: Notification > Telegram
Description:
Section titled “Description:”This node sends an alert message to a Telegram chat, notifying users with the provided alert data. It requires configuration through NodeAlertTelegramConfig, where the bot token, chat ID, and other necessary Telegram API settings are defined. This node is useful for sending automated alerts, notifications, or critical updates to Telegram groups or individual users, making it an essential tool for real-time communication. The alert data, which includes the message content and any additional details, is passed to the node and sent via the Telegram bot. The output indicates whether the alert was successfully delivered.
Inputs: (1)
- Telegram Data : The alert data to be sent to Telegram, containing the message content, chat ID, and other optional metadata for the notification.
Outputs: (1)
Section titled “Outputs: (1)”- Is Success : Success
Configuration:
Section titled “Configuration:”The following configuration parameters can be set for this node:
NodeAlertTelegramConfig: {
# The API token for authenticating with Telegram. apitoken: string, # The chat ID where alerts will be sent in Telegram. chatid: string,}Generate Notification
Section titled “Generate Notification”Generate a Frontend notification based on the provided configuration.
Metadata:
Section titled “Metadata:”- Name: GetNotificationFrontend
- Tags: notification, generate, frontend, config, trigger, dynamic
- Category: Generate
- Subcategory: Notification > Frontend
Description:
Section titled “Description:”This node generates a notification for the Frontend based on a specified trigger. It uses the provided configuration to construct the notification, which is then sent to the Frontend for display. This is useful for creating dynamic notifications that can be triggered by various conditions or events in the system. The configuration must follow the Notification format, which defines the content and structure of the notification.
Inputs: (1)
- Trigger : A boolean trigger that initiates the generation of the notification. When set to
true, the node constructs and sends the notification based on the provided configuration.
Outputs: (1)
Section titled “Outputs: (1)”- Notification : Output for Notification data
Configuration:
Section titled “Configuration:”The following configuration parameters can be set for this node:
Notification: {
# The title of the notification. title: string, # The message of the notification. message: string, # The source of the notification. source: string, # The level of the notification. level: string, # The timestamp of the notification. timestamp: google.protobuf.Timestamp, # The icon of the notification. icon: string,}Notification Frontend
Section titled “Notification Frontend”Send a notification to the Frontend to inform the user.
Metadata:
Section titled “Metadata:”- Name: NotificationFrontend
- Tags: notification, fire, frontend, user, alert, message
- Category: Action
- Subcategory: Notification > Frontend
Description:
Section titled “Description:”This node sends a notification directly to the Frontend, informing the user with the provided notification data. It is essential for delivering real-time updates, alerts, or messages in user-facing applications. The node does not require any additional configuration, making it simple to use for triggering notifications based on dynamic events or system states. The notification data must be structured according to the Notification proto format and is passed into the node for display on the Frontend.
Inputs: (1)
- Notification Data : The notification data to send to the Frontend, which includes details like the message content, type, and any additional metadata for display.
Outputs: (0)
Section titled “Outputs: (0)”Configuration:
Section titled “Configuration:”No configuration required for this node.