Send Message With File with Discord API on New Remote Directory Watcher from SFTP (password-based auth) API

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

Trigger workflow on

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

Next, do this

Send Message With File with the Discord 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 Discord 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 Send Message With File action
1. Connect your Discord account
2. Configure channel
3. Optional- Configure Message
4. Optional- Configure Thread ID
5. Optional- Configure Username
6. Optional- Configure Avatar URL
7. Optional- Configure Include link to workflow
8. Optional- Configure File URL
9. Optional- Configure File Path
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#

Send Message With File on Discord

Description:Post a message with an attached file

Version:1.1.0

Key:discord-send-message-with-file

View on GitHub

Discord Overview#

The Pipedream Discord app enables you to build event-driven workflows that interact with the Discord API. When you authorize the Pipedream app's access to your guilds, you can use Pipedream workflows to perform common Discord actions, or write your own code against the Discord API.

Action Code#

import common from "../common/common.mjs";
import { axios } from "@pipedream/platform";
import fs from "fs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...common,
  key: "discord-send-message-with-file",
  name: "Send Message With File",
  description: "Post a message with an attached file",
  version: "1.1.0",
  type: "action",
  props: {
    ...common.props,
    message: {
      propDefinition: [
        common.props.discord,
        "message",
      ],
      optional: true,
    },
    fileUrl: {
      propDefinition: [
        common.props.discord,
        "fileUrl",
      ],
    },
    filePath: {
      propDefinition: [
        common.props.discord,
        "filePath",
      ],
    },
  },
  async run({ $ }) {
    const {
      message,
      avatarURL,
      threadID,
      username,
      fileUrl,
      filePath,
      includeSentViaPipedream,
    } = this;

    if (!fileUrl && !filePath) {
      throw new ConfigurationError("This action requires either File URL or File Path. Please enter one or the other above.");
    }

    const file = fileUrl
      ? await axios($, {
        method: "get",
        url: fileUrl,
        responseType: "stream",
      })
      : fs.createReadStream(filePath);

    try {
      const resp = await this.discord.sendMessage(this.channel, {
        avatar_url: avatarURL,
        username,
        file,
        content: includeSentViaPipedream
          ? this.appendPipedreamText(message ?? "")
          : message,
      }, {
        thread_id: threadID,
      });
      $.export("$summary", "Message sent successfully");
      return resp || {
        success: true,
      };
    } catch (err) {
      const unsentMessage = this.getUserInputProps();
      $.export("unsent", unsentMessage);
      throw err;
    }
  },
};

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
Discord	`discord`	`app`	This component uses the Discord app.
channel	`channel`	`$.discord.channel`
Message	`message`	`string`	Enter a simple message up to 2000 characters. This is the most commonly used field. However, it's optional if you pass embed content.
Thread ID	`threadID`	`string`	If provided, the message will be posted to this thread
Username	`username`	`string`	Overrides the current username of the webhook
Avatar URL	`avatarURL`	`string`	If used, it overrides the default avatar of the webhook. Note: Consecutive posts by the same username within 10 minutes of each other will not display updated avatar.
Include link to workflow	`includeSentViaPipedream`	`boolean`	Defaults to `true`, includes a link to this workflow at the end of your Discord message.
File URL	`fileUrl`	`string`	The URL of the file to attach. Must specify either File URL or File Path.
File Path	`filePath`	`string`	The path to the file, e.g. `/tmp/myFile.csv`. Must specify either File URL or File Path.

Action Authentication#

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

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

botemailidentifyguilds