SiYuan icon

SiYuan

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

System → Push Message

AI-generated

Summary

Displays an informational toast notification in the SiYuan interface for a specified duration.

Inputs

  • message (required) — The text to display in the notification.
  • timeout — How long the notification stays visible, in milliseconds. Defaults to 7000.

Output shape

No data — success/failure only

Returns null or an empty object upon successful display.

Examples

Example 1: Display a notification when a workflow completes successfully

Message: 'Workflow executed successfully', Timeout: 5000

Example 2: Show an informational toast for a user action

Message: 'Data synced to SiYuan', Timeout: 10000

Links

Discussion