View as Markdown
SFTP (key-based auth) icon

SFTP (key-based auth) TRIGGER

New Remote Directory Watcher

Emit new events when files get created, changed or deleted from a remote directory. See the docs
  • Trigger
  • Polling
  • API key
  • Webhook delivery

IMPLEMENTATION

Deploy this event source

Connect the user's SFTP (key-based auth) account, configure the source, and choose the webhook where your backend receives events.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const deployed = await pd.triggers.deploy({
  id: "sftp-watch-remote-directory",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sftp: { authProvisionId: "apn_xxxxxxx" },
    timer: { "intervalSeconds": 900 },
    rootDirectory: "Root directory",
  },
  webhookUrl: "https://example.com/webhooks/sftp",
})

console.log(deployed.id)

MCP exposes on-demand actions. Event sources are deployed through the Connect SDK or API because they continue listening after the initial request.

SCHEMA

Configuration

These inputs define which events the source watches. Dynamic options are loaded from the connected account.

New Remote Directory Watcher configuration
Property Type Description
timer Timer $.interface.timer
Required
rootDirectory Root directory string
Root directory to be watched. example: /public
Required
maxDepth Maximum watcher depth integer
Watch all subdirectories within of the root directory, considering the selected maximum depth.
Required

01

Connect

Your user authorizes SFTP (key-based auth) through Pipedream managed auth.

02

Deploy

Your backend deploys this source with that user's own configuration.

03

Webhook delivery

Every event is sent to the HTTP endpoint you choose when you deploy the source — after each poll.

OR

On-demand retrieval

No webhook required. Your app or agent can fetch recent events from the trigger events API.

Registry key
sftp-watch-remote-directory
Version
0.1.1
App
SFTP (key-based auth)
Authentication
API key
Delivery
Polling source
Output
Events emitted by SFTP (key-based auth).