SFTP Trigger

Node catalog Triggers

On this page

Poll a directory for SFTP file changes.

Usage and specifics

FTP uses an FTP credential; SFTP uses an SSH credential. Check remote paths and permissions before writing or deleting. Triggers poll files after publishing; interval and filters determine detected events.

Technical type : sftp_trigger. Runtime : nodulz.

Credentials and prerequisites

Create and configure the credential : ssh

Create credentials in your nodulz instance’s Credentials area, then select them on the node. Availability depends on ownership and sharing. See the credentials guide for access and rotation.

Parameters

Names below are technical keys. Defaults are not a ready-to-run configuration: complete fields required by your operation. Paths containing [] describe list items; some fields depend on the selected mode.

Parameter	Type	Default	Values / limits
`credentialId`	`string`	`""`	-
`path`	`string`	`"."`	-
`events`	`array`	`["created"]`	-; min 1
`pollInterval`	`number`	`60`	-; ≥ 10, ≤ 86400
`testPayload`	`string`	`""`	-

Configuration help

events Events: File creation, modification or deletion. Changes are detected by remote size or modification time, without comparing content.
pollInterval Interval (seconds): Between 10 and 86,400 seconds. Changes between scans may be missed. Limit: 10,000 entries or 5 MiB per directory.
testPayload Test data (JSON): Optional JSON object for manual tests, without connecting to the server. Leave empty for generated sample data.

Initial configuration

Initial catalog configuration example, to adapt before running. Keep secrets in credentials.

json

{
  "credentialId": "",
  "path": ".",
  "events": [
    "created"
  ],
  "pollInterval": 60,
  "testPayload": ""
}

Verification

Test with representative data. Check node output in the inspector and logs, then use editor mapping for downstream fields. A trigger test with a simulated payload does not validate external service delivery.