Download File to Tmp Direcory with Zoho WorkDrive API on New Remote Directory Watcher (Password Auth) from SFTP (password-based auth) API

Pipedream makes it easy to connect APIs for Zoho WorkDrive, SFTP (password-based auth) and 2,800+ other apps remarkably fast.

Trigger workflow on

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

Next, do this

Download File to Tmp Direcory with the Zoho WorkDrive API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,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 Zoho WorkDrive 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 (Password Auth) trigger
1. Connect your SFTP (password-based auth) account
2. Configure timer
3. Configure Root directory
4. Configure Maximum watcher depth
Configure the Download File to Tmp Direcory action
1. Connect your Zoho WorkDrive account
2. Select a Team Id
3. Select a Folder Type
4. Select a Folder Id
5. Select a File Id
6. Optional- Configure Filename
7. Configure syncDir
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 (Password Auth) 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.1.2

Key:sftp_password_based_auth-watch-remote-directory

View on GitHub

SFTP (password-based auth) Overview#

SFTP on Pipedream enables secure file management on remote servers directly from your workflows. Utilize this app to automate file uploads, downloads, and synchronization tasks between your systems and SFTP servers. Implement robust data pipelines or deploy content to web servers without manual intervention, all while maintaining a high level of security with password-based authentication.

Trigger Code#

import utils from "../../common/utils.mjs";
import component from "@pipedream/sftp/sources/watch-remote-directory/watch-remote-directory.mjs";

export default {
  ...component,
  props: utils.buildAppProps({
    component,
  }),
  key: "sftp_password_based_auth-watch-remote-directory",
  name: "New Remote Directory Watcher (Password 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.1.2",
  type: "source",
};

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)	`app`	`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#

Download File to Tmp Direcory on Zoho WorkDrive

Description:Download a file to the /tmp directory. [See the documentation](https://workdrive.zoho.com/apidocs/v1/filesfolders/downloadserverfile)

Version:0.0.4

Key:zoho_workdrive-download-file

View on GitHub

Zoho WorkDrive Overview#

The Zoho WorkDrive API interacts with Zoho's cloud-based file management system, enabling automated file and folder operations, team management, and content collaboration. With Pipedream, you can harness this API to create workflows that trigger on specific events, manipulate files and folders, and integrate with other services for a seamless productivity boost.

Action Code#

import app from "../../zoho_workdrive.app.mjs";
import { getFilePath } from "../../common/utils.mjs";
import { LIMIT } from "../../common/constants.mjs";
import fs from "fs";

export default {
  key: "zoho_workdrive-download-file",
  name: "Download File to Tmp Direcory",
  description: "Download a file to the /tmp directory. [See the documentation](https://workdrive.zoho.com/apidocs/v1/filesfolders/downloadserverfile)",
  version: "0.0.4",
  type: "action",
  props: {
    app,
    teamId: {
      propDefinition: [
        app,
        "teamId",
      ],
    },
    folderType: {
      propDefinition: [
        app,
        "folderType",
      ],
    },
    folderId: {
      propDefinition: [
        app,
        "parentId",
        ({
          teamId, folderType,
        }) => ({
          teamId,
          folderType,
        }),
      ],
      label: "Folder Id",
      description: "The unique ID of the folder where file is located.",
    },
    fileId: {
      type: "string",
      label: "File Id",
      description: "The unique ID of the file to download.",
      withLabel: true,
      async options({ page }) {
        const { data } = await this.app.listFiles({
          folderId: this.folderId,
          filter: "allfiles",
          params: new URLSearchParams({
            "page[limit]": LIMIT,
            "page[offset]": LIMIT * page,
          }).toString(),
        });
        return data.map(({
          id, attributes,
        }) => ({
          value: id,
          label: attributes.name,
        }));
      },
    },
    fileName: {
      type: "string",
      label: "Filename",
      description: "What to name the new file saved to /tmp directory",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "write",
      sync: true,
    },
  },
  methods: {
    downloadFile({
      fileId, ...args
    }) {
      return this.app._makeRequest({
        url: `https://download.${this.app.$auth.base_api_uri}/v1/workdrive/download/${fileId}`,
        responseType: "arraybuffer",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const fileId = this.fileId?.value ?? this.fileId;
    const fileName = this.fileName ?? this.fileId?.label ?? "file";
    const filePath = getFilePath(fileName);

    const fileContent = await this.downloadFile({
      fileId,
    });

    fs.writeFileSync(filePath, fileContent);

    $.export("$summary", `The file was successfully downloaded to \`${filePath}\`.`);

    return filePath;
  },
};

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
Zoho WorkDrive	`app`	`app`	This component uses the Zoho WorkDrive app.
Team Id	`teamId`	`string`	Select a value from the drop down menu.
Folder Type	`folderType`	`string`	Select a value from the drop down menu.
Folder Id	`folderId`	`string`	Select a value from the drop down menu.
File Id	`fileId`	`string`	Select a value from the drop down menu.
Filename	`fileName`	`string`	What to name the new file saved to /tmp directory
syncDir	`syncDir`	`dir`

Action Authentication#

Zoho WorkDrive uses OAuth authentication. When you connect your Zoho WorkDrive account, Pipedream will open a popup window where you can sign into Zoho WorkDrive and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zoho WorkDrive API.

Pipedream requests the following authorization scopes when you connect your account:

WorkDrive.files.CREATEWorkDrive.files.READWorkDrive.files.UPDATEWorkDrive.files.DELETEWorkDrive.team.READWorkDrive.teamfolders.READWorkDrive.workspace.CREATEWorkDrive.workspace.UPDATEWorkDrive.workspace.DELETEZohoSearch.securesearch.READZohoFiles.files.READ