Add or update a single record with Data Stores API on New Remote Directory Watcher from SFTP (password-based auth) API

Pipedream makes it easy to connect APIs for Data Stores, SFTP (password-based auth) and 1400+ other apps remarkably fast.

Trigger workflow on

New Remote Directory Watcher from the SFTP (password-based auth) API

Next, do this

Add or update a single record with the Data Stores API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

Trusted by 500,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a SFTP (password-based auth) trigger and Data Stores action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Remote Directory Watcher trigger
1. Connect your SFTP (password-based auth) account
2. Configure timer
3. Configure Root directory
4. Configure Maximum watcher depth
Configure the Add or update a single record action
1. Connect your Data Stores account
2. Configure Data Store
3. Select a Key
4. Configure Value
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Remote Directory Watcher on SFTP (password-based auth)

Description:Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)

Version:0.0.1

Key:sftp_password_based_auth-watch-remote-directory

View on GitHub

SFTP (password-based auth) Overview#

SFTP (Secure File Transfer Protocol) is a network protocol that provides secure
file transfers over secure shell (SSH) connections. It is an extension of the
Secure Shell protocol, designed for secure file exchange between hosts. A user
can securely transfer files between systems without having to worry about
external threats, as the protocol is encrypted and authenticated.

With the SFTP API, you can build applications that securely transfer data, such
as files and documents, between two different systems. Some example
applications include:

Secure document sharing between two systems
Secure file synchronization between two systems
Secure backups of data over the network
Secure transfers of large files
Secure uploads and downloads of data
Media streaming between two systems

Trigger Code#

import sftpApp from "../../sftp_password_based_auth.app.mjs";
import base from "../../../sftp/sources/watch-remote-directory/watch-remote-directory.mjs";

export default {
  ...base,
  key: "sftp_password_based_auth-watch-remote-directory",
  name: "New Remote Directory Watcher",
  description: "Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)",
  version: "0.0.1",
  type: "source",
  props: {
    ...base.props,
    sftpApp,
  },
  methods: {
    ...base.methods,
    async connect() {
      return await this.sftpApp.connect();
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
SFTP (password-based auth)	`sftpApp`	`app`	This component uses the SFTP (password-based auth) app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Root directory	`rootDirectory`	`string`	Root directory to be watched. example: `/public`
Maximum watcher depth	`maxDepth`	`integer`	Watch all subdirectories within of the root directory, considering the selected maximum depth.

Trigger Authentication#

SFTP (password-based auth) uses API keys for authentication. When you connect your SFTP (password-based auth) account, Pipedream securely stores the keys so you can easily authenticate to SFTP (password-based auth) APIs in both code and no-code steps.

Below, enter the hostname of the SFTP server you'd like to connect to, your username, and the password you'd like to use to connect.

This app only supports password-based authentication, not authentication via private key. If you need to use a private key to connect to a host, please use the SFTP (key-based auth) app, instead.

About SFTP (password-based auth)#

Interact with an SFTP (SSH File Transfer Protocol) Server using a username and password for auth

Action#

Add or update a single record on Data Stores

Description:Add or update a single record in your [Pipedream Data Store](https://pipedream.com/data-stores/).

Version:0.0.9

Key:data_stores-add-update-record

View on GitHub

Data Stores Overview#

With the Data Stores API, you can build applications that:

Store data for later retrieval
Retrieve data from a store
Update data in a store
Delete data from a store

Action Code#

import app from "../../data_stores.app.mjs";

export default {
  key: "data_stores-add-update-record",
  name: "Add or update a single record",
  description: "Add or update a single record in your [Pipedream Data Store](https://pipedream.com/data-stores/).",
  version: "0.0.9",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    key: {
      propDefinition: [
        app,
        "key",
        ({ dataStore }) => ({
          dataStore,
        }),
      ],
      description: "Enter a key for the record you'd like to create or select an existing key to update.",
    },
    value: {
      propDefinition: [
        app,
        "value",
      ],
    },
  },
  async run({ $ }) {
    const {
      key,
      value,
    } = this;
    const exists = await this.dataStore.has(key);
    const parsedValue = this.app.parseValue(value);
    await this.dataStore.set(key, parsedValue);
    // eslint-disable-next-line multiline-ternary
    $.export("$summary", `Successfully ${exists ? "updated the record for" : "added a new record with the"} key, \`${key}\`.`);
    return {
      key,
      value: parsedValue,
    };
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Data Stores	`app`	`app`	This component uses the Data Stores app.
Data Store	`dataStore`	`data_store`	Select an existing Data Store or create a new one.
Key	`key`	`string`	Select a value from the drop down menu.
Value	`value`	`any`	Enter a string, object, or array.