Files Watcher Documentation

Version: 2.0.0 

Retrieved: 2025-10-09 15:15:52

File(s) Watcher

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

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

Settings

Name Requirements Purpose Default
Directory String with length 1-64 The top-directory to watch. Empty setting will default to ./ ./data/tmp/
File Pattern String with length 1-64 The file pattern to watch. Empty setting will default to *.* *.*
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

Input

The module does not have any input and will only provide messages to the next module when a monitored file system event is fired.

Output

Information about the file system event that occured.

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,
    fullPath: ./example
  }
}

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

Destinations

Files