Actions25
- Append Block
- Create Document
- Create Notebook
- Delete Block
- Execute SQL Query
- Export Document Markdown
- Get Block Attributes
- Get Block Kramdown
- Get Child Blocks
- Get Document ID by Path
- Get Document Path by ID
- Insert Block
- List Documents in Notebook
- List Files in Directory
- Move Document
- Prepend Block
- Push Error Message
- Push Message
- Remove Document
- Remove Notebook
- Rename Document
- Rename Notebook
- Render Sprig Template
- Set Block Attributes
- Update Block
Overview
This node integrates with the SiYuan API, enabling automation and interaction with the SiYuan note-taking and knowledge management system. It supports a wide range of operations such as creating notebooks and documents, managing blocks of content, querying data, and displaying notifications within the SiYuan user interface.
The Push Message operation specifically allows users to display informational popup notifications (toast messages) inside the SiYuan UI. This is useful for alerting users about events, confirmations, or other important information during automated workflows.
Practical examples:
- Notify a user that a document was successfully created.
- Show an error message if a certain condition fails in your workflow.
- Display reminders or status updates directly in the SiYuan app interface.
Properties
| Name | Meaning |
|---|---|
| Message | The text content of the notification message you want to show in SiYuan. |
| Timeout (Ms) | Duration in milliseconds for how long the notification should remain visible (e.g., 7000). |
Output
The output is a JSON object representing the result of the push message operation. Typically, it contains a success confirmation or any returned data from the SiYuan API related to the notification action.
The node does not output binary data for this operation.
Example output JSON might look like:
{
"success": true
}
Dependencies
- Requires valid credentials for the SiYuan API, including:
- The base URL of the SiYuan instance.
- An API authentication token.
- These credentials must be configured in n8n prior to using the node.
- The node depends on the
SiYuanClientlibrary to communicate with the SiYuan API.
Troubleshooting
- Missing Credentials Error: If the API URL or token is missing, the node will throw a "Credentials missing!" error. Ensure that the SiYuan API credentials are properly set up in n8n.
- Unsupported Operation: If an unsupported operation name is provided, the node throws an error indicating the operation is not supported.
- Timeouts or Network Issues: Since the node communicates with an external API, network problems or incorrect URLs can cause failures. Verify connectivity and API endpoint correctness.
- Message Not Showing: If the notification does not appear in SiYuan, check that the API token has sufficient permissions and that the SiYuan instance supports toast notifications.