home-assistant.io/source/_integrations/folder_watcher.markdown

title, description, ha_category, ha_iot_class, ha_release, ha_quality_scale, ha_domain, ha_integration_type

title	description	ha_category	ha_iot_class	ha_release	ha_quality_scale	ha_domain	ha_integration_type
Folder Watcher	Integration for monitoring changes within the filesystem.	System monitor	Local Polling	0.67	internal	folder_watcher	integration

This integration adds Watchdog file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored event_type are:

• closed
• created
• deleted
• modified
• moved

Configured folders must be added to allowlist_external_dirs. Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.

Configuration

To enable the Folder Watcher integration in your installation, add the following to your configuration.yaml file:

folder_watcher:
  - folder: /config

{% configuration %} folder: description: The folder path required: true type: string patterns: description: Pattern matching to apply required: false default: "*" type: string {% endconfiguration %}

Patterns

Pattern matching using fnmatch can be used to limit filesystem monitoring to only files which match the configured patterns. The following example shows the configuration required to only monitor filetypes .yaml and .txt.

folder_watcher:
  - folder: /config
    patterns:
      - '*.yaml'
      - '*.txt'

Automations

The elements the events contain are:

• event_type: matching the event_type of the filter (one of created, moved, modified, deleted, closed)
• path: The full path to the file (e.g. "/hello/world.txt")
• file: The name of the file (e.g. "world.txt")
• folder: The folder path (e.g. "/hello")

When the event_type is moved, the file details are for the source file and destination details are included:

• dest_path: The full path to the moved file (e.g. "/hello/world.txt")
• dest_file: The name of the moved file (e.g. "world.txt")
• dest_folder: The folder moved path (e.g. "/hello")

Automations can be triggered on filesystem event data using a template. The following automation will send a notification with the name and folder of new files added to that folder:

{% raw %}

#Send notification for new image (including the image itself)
automation:
  alias: "New file alert"
  trigger:
    platform: event
    event_type: folder_watcher
    event_data:
      event_type: created
  action:
    service: notify.notify
    data:
      title: New image captured!
      message: "Created {{ trigger.event.data.file }} in {{ trigger.event.data.folder }}"
      data:
        file: "{{ trigger.event.data.path }}"

{% endraw %}