synology

n8n community nodes for Synology NAS applications

Package Information

Released: 2 mo ago
Downloads: 2 weekly / 86 monthly
Latest Version: 0.2.1

Available Nodes

Documentation generating…

Synology Note Station icon
Synology Note Station
Automate Synology Note Station notebooks, notes, shelves, shares, and attachments
Synology Drive icon
Synology Drive
Synology Drive Node
Synology Download Station icon
Synology Download Station
Manage Synology Download Station tasks: create, list, pause, resume, delete, and get statistics
Synology MailPlus icon
Synology MailPlus
Work with Synology MailPlus email: list threads and messages, read mail, manage drafts, download attachments
Synology MailPlus Trigger icon
Synology MailPlus Trigger
Triggers when new mail arrives in a Synology MailPlus mailbox
Synology Chat icon
Synology Chat
Work with Synology Chat: send messages, list channels and posts, manage bots and webhooks
Synology Chat Trigger icon
Synology Chat Trigger
Triggers when a Synology Chat outgoing webhook receives a matching message
Synology Photos icon
Synology Photos
Work with Synology Photos: list albums and photos, download originals and thumbnails, search

Documentation

n8n-nodes-synology

n8n community nodes for Synology NAS applications.

This package provides a shared Synology API credential and nodes for Synology Note Station, Drive, Download Station, MailPlus, Chat, and Photos.

Supported nodes

Synology Note Station

  • Notebook, note, shelf/stack, and public-share operations
  • User/group sharing and share-principal listing
  • Note Station info and tag listing
  • Optional full-note retrieval after note creation/update
  • Upload files from n8n binary data

Synology Drive

  • List, search, create, upload, download, copy, and delete files/folders
  • Recently used items and metadata
  • Team Folders
  • Labels: list, create, delete, and apply
  • Public and advanced sharing links

Drive uses a separate Drive session internally and handles the required id and did cookies. Availability of some features depends on the installed Drive Server version and user permissions.

Synology Download Station

  • Create URL or magnet-link tasks
  • List, inspect, pause, resume, and delete tasks
  • Download/upload statistics and server configuration
  • BT search modules
  • Torrent-file upload through the verified Download Station frontend contract

Synology MailPlus

Synology MailPlus provides MailPlus operations (not the legacy Synology Mail app). Synology MailPlus Trigger is a polling trigger for new mailbox threads (same package, nodes/SynologyMailPlusClient/).

Trigger options include:

  • Mailbox
  • Search keyword
  • Sender (From)
  • Unread-only mode
  • Read status: both, unread, or read
  • Starred-only mode
  • Has-attachment-only mode
  • Label name or ID
  • Maximum threads per poll

The trigger tracks previously seen thread IDs in workflow static data and emits matching threads with mailbox metadata, thread data, and messages.

Synology Chat

Synology Chat supports:

  • Send a Message as the credential DSM user to a channel or direct message
    (session Post.create — same as the web client, no webhook/bot)
  • List channels, users, and posts (session API)
  • Manage incoming webhooks, chatbots, and channels
  • Manage outgoing webhooks

Synology Chat Trigger receives Synology Chat outgoing-webhook requests over an n8n webhook. When the workflow is activated, it creates and manages the corresponding Synology Chat outgoing webhook automatically.

Trigger options include:

  • Channel ID, or any channel when set to 0
  • Trigger word prefix
  • Outgoing-webhook nickname

Only matching messages are emitted to the workflow. The incoming Chat webhook payload is passed through unchanged.

Synology Photos

Photo operations are available through the Synology Photos node. Availability depends on the installed Synology Photos version and account permissions.

Credentials

Create a credential of type Synology API:

  • NAS URL, for example https://192.168.1.100:5001
  • DSM username
  • DSM password
  • Whether self-signed TLS certificates are allowed

Each node selects the required Synology application session internally. Note Station uses the NoteStation session; Drive and MailPlus use their respective application APIs. Legacy Synology Mail is not supported yet.

Development

npm install
npm run build
npm run lint

E2E tests

E2E scripts require a running n8n instance and Synology NAS credentials (SYNO_BASE_URL, SYNO_ACCOUNT, SYNO_PASS). See AGENTS.md for the full command list and CI smoke suite.

See docs/ROADMAP.md for the development plan.

License

MIT

Discussion