SFTP Files Watcher Documentation

Version: 1.1.0

Retrieved: 2025-10-09 15:16:19

SFTP File(s) Watcher

Allows you to subscribe to SFTP file events such as file created, file changed and file deleted.

This module is designed to be located at the start of a flow.

Settings

Name	Requirements	Purpose	Default
Host	String with length 1-128	The SFTP server to use	localhost
Port	Number	The port to use	22
Remote Directory	String with length 1-64	The top-remote directory to watch. Empty setting will default to ./	./data/tmp/
File Pattern	String with length 1-64	The file pattern to use	*.txt
Watch Created	Boolean	If true the module will watch for file creations matching the File Pattern.	true
Watch Deleted	Boolean	If true the module will watch for file deletions matching the File Pattern.	false
Watch Changed	Boolean	If true the module will watch for file changes matching the File Pattern.	false
Include Subfolders	Boolean	If true the module will watch subfolders as well.	false
Ignore ssh errors	Boolean	If true the module will try to ignore various ssh errors	true

Input

The module will trigger a comparison each time it receives a message.

Output

Information on all the changes since the least received message

For example, if you monitor the folder example and the change type created the message will look like this if a file named foo.txt is created.

{
  file: {
    name: foo.txt,
    directory: example
    changeType: Created,
  }
}

Note

The File Changed event will be fired when files are created and deleted, so you may get mutiple messages with different change types if subscribing for both Created and Changed for example

Search Documentation

Data Sources

Files