CreateNotification
Sends a new notification to users, detailing specific events or updates.
Input
Name | Type | Required | Description |
Text | String | True | The content of the notification message, providing the information or alert to be sent to the target. |
UserId | String | True | The unique identifier for the user initiating or receiving the notification, typically used to reference the user's account in the system. |
TargetId | String | True | The unique identifier for the target object of the notification, which can be a project, post, or another relevant entity. |
TargetType | String | True | The type of the target object (for example, Project or Post) that the notification pertains to, used to determine the context of the notification.
The allowed values are Project, Post. |
Result Set Columns
Name | Type | Description |
Success | Boolean | A flag indicating the outcome of the operation. A true value signifies that the notification was successfully sent or processed, while false indicates failure. |
Details | String | Additional information about the operation, such as an error message or context, useful for troubleshooting or understanding the result of the operation. |
NotificationId | String | The unique identifier for the notification that was created or processed, which can be used to reference or track the notification in the system. |