Notification

Description

The Notification node sends messages or alerts to specific users or groups within the MinuteView platform.
It supports two delivery types:

• Toast — Displays a real-time pop-up message in the user’s interface (e.g., “Task Completed Successfully”).
• Notification — Sends a system notification to the user’s inbox within the MinuteView app (persistent, includes subject and body).

This node can be used in workflows to alert users about process results, approvals, automation failures, or data changes.

---

How It Works

1. The node validates the notification type (Toast or Notification) and ensures required fields are provided.
2. Depending on the type, it constructs the appropriate DTO and sends a web request to the MinuteView API:
   • /MinuteView/api/ToastNotifications for toast pop-ups
   • /MinuteView/api/notifications for system notifications
3. Recipients can be targeted by Users and/or Groups.
4. The message is dispatched immediately through the MinuteView notification system.

---

Notification Types

Type	Description	Use Case
Toast	Real-time pop-up message (temporary)	Instant feedback on workflow success or failure
Notification	Persistent message in user inbox	Task updates, system alerts, approval requests

---

Input Fields

Field	Type	Description	Required
Notification Type	Picklist	Type of message to send — Toast or Notification.	✅
Recipients (Users)	Text / User Selector	Comma-separated list of usernames or user IDs.	✅ (if Groups empty)
Recipients (Groups)	Text / Group Selector	Comma-separated list of group IDs.	✅ (if Users empty)
Body	Text (multi-line)	The main content of the message.	✅

When Notification Type = "Toast"

Field	Type	Description	Required
Header	Text	The short title or heading of the toast message.	✅
Toast Type	Picklist	The toast style to display: Success or Error.	✅

When Notification Type = "Notification"

Field	Type	Description	Required
Subject	Text	The subject line of the notification message.	✅

---

Output Data

Output Variable	Type	Description
taskMessage	String	Returns "Notification sent" on success.
statusReturn	String	Completed if successful, or Fail if the message could not be sent.

---

Example Configurations

✅ Toast Example (Success Message)

Setting	Value
Notification Type	Toast
Header	Workflow Complete
Body	The drawing export process has finished successfully.
Toast Type	Success
Recipients (Users)	jtennent

Result:
Displays a green success toast on the user’s screen.

---

⚠️ Toast Example (Error Message)

Setting	Value
Notification Type	Toast
Header	Export Failed
Body	Unable to process the DWG file. Please check logs for details.
Toast Type	Error
Recipients (Groups)	Design Team

Result:
Displays a red error toast to all users in the “Design Team” group.

---

📩 System Notification Example

Setting	Value
Notification Type	Notification
Subject	New Revision Uploaded
Body	A new revision has been uploaded for project: HVAC_Main_Plant. Please review.
Recipients (Users)	sarahj, mthompson

Result:
Sends a persistent MinuteView notification with the subject “New Revision Uploaded” to the specified users.

---

Task Flow Summary

Step	Action
1	Validates all required fields based on Notification Type.
2	Prepares payload for /api/ToastNotifications or /api/notifications.
3	Sends notification to MinuteView Web API via internal service account.
4	Returns success or failure result to workflow.

---

Status Messages

Status	Description
Completed	Notification sent successfully.
Fail	Invalid input, missing recipients, or API failure.

---

Error Handling

If the task fails, it logs the error message in the workflow execution log and sets:

statusReturn = "Fail"
taskSuccess = false

Common causes include:

• Missing notification type
• No users or groups defined
• API endpoint unreachable
• Invalid JSON or DTO payload

---

Example Workflow Integration

graph LR
    A[AutoCAD Export] --> B{Export Status}
    B -->|Success| C[Notification (Toast: Success)]
    B -->|Failure| D[Notification (Toast: Error)]

---

Notes

• The node requires the MinuteView server’s internal API endpoints to be reachable.
• Toast notifications are intended for immediate feedback; they are not persistent.
• System notifications appear in the user’s inbox and remain until dismissed.
• Users and groups can be combined for multiple recipients.
• Multiple Notification nodes can be chained for layered messaging (e.g., one toast + one email).

---

Category: Utilities Task Name: Notification