SiYuan icon

SiYuan

Manage SiYuan notebooks, documents, blocks, attributes, and more. Designed for AI agent workflows.

System → Push Message

AI-generated

Overview

This node operation sends a push notification message within the SiYuan system. It is useful for alerting users or providing real-time updates directly through the SiYuan interface. For example, it can be used to notify users about task completions, errors, or important system events.

Use Case Examples

  1. Sending a notification message to inform a user that a document has been successfully saved.
  2. Pushing an error message alert when a system operation fails.

Properties

Name Meaning
Message The text content to display in the notification message.
Timeout (Ms) Duration in milliseconds for how long the notification remains visible.

Output

JSON

  • success - Indicates whether the push message operation was successful.

Dependencies

  • Requires SiYuan API URL and API token credentials for authentication.

Troubleshooting

  • Ensure that the SiYuan API URL and token credentials are correctly configured; missing or invalid credentials will cause authentication errors.
  • If the notification does not appear, verify that the message text is not empty and the timeout value is a positive number.
  • Common error messages include unsupported resource or operation errors if the resource or operation parameters are incorrect.

Discussion