← SFTP (password-based auth) + GitHub integrations

Create Issue Comment with GitHub API on New Remote Directory Watcher from SFTP (password-based auth) API

Pipedream makes it easy to connect APIs for GitHub, 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
Create Issue Comment with the GitHub API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

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

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers Pipedream

Getting Started

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

  1. Select this integration
  2. 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
  3. Configure the Create Issue Comment action
    1. Connect your GitHub account
    2. Select a Repository
    3. Select a Issue Number
    4. Configure Body
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. 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

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

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.
LabelPropTypeDescription
SFTP (password-based auth)sftpAppappThis component uses the SFTP (password-based auth) app.
timer$.interface.timer
N/Adb$.service.dbThis component uses $.service.db to maintain state between executions.
Root directoryrootDirectorystring

Root directory to be watched. example: /public

Maximum watcher depthmaxDepthinteger

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

Description:Create a new comment in a issue. [See docs here](https://docs.github.com/en/rest/issues/comments#create-an-issue-comment)
Version:0.0.8
Key:github-create-issue-comment

Action Code

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

export default {
  key: "github-create-issue-comment",
  name: "Create Issue Comment",
  description: "Create a new comment in a issue. [See docs here](https://docs.github.com/en/rest/issues/comments#create-an-issue-comment)",
  version: "0.0.8",
  type: "action",
  props: {
    github,
    repoFullname: {
      propDefinition: [
        github,
        "repoFullname",
      ],
    },
    issueNumber: {
      label: "Issue Number",
      description: "The number that identifies the issue.",
      type: "integer",
      propDefinition: [
        github,
        "issueNumber",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
    },
    body: {
      label: "Body",
      description: "The contents of the comment",
      type: "string",
    },
  },
  async run({ $ }) {
    const response = await this.github.createIssueComment({
      repoFullname: this.repoFullname,
      issueNumber: this.issueNumber,
      data: {
        body: this.body,
      },
    });

    $.export("$summary", "Successfully commented in the issue.");

    return response;
  },
};

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.

LabelPropTypeDescription
GitHubgithubappThis component uses the GitHub app.
RepositoryrepoFullnamestringSelect a value from the drop down menu.
Issue NumberissueNumberintegerSelect a value from the drop down menu.
Bodybodystring

The contents of the comment

Action Authentication

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

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

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

About GitHub

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

More Ways to Connect GitHub + SFTP (password-based auth)

Search Issues and Pull Requests with GitHub API on New Remote Directory Watcher from SFTP (password-based auth) API
SFTP (password-based auth) + GitHub
 
Try it
Create Issue with GitHub API on New Remote Directory Watcher from SFTP (password-based auth) API
SFTP (password-based auth) + GitHub
 
Try it
Get Repository with GitHub API on New Remote Directory Watcher from SFTP (password-based auth) API
SFTP (password-based auth) + GitHub
 
Try it
Update Issue with GitHub API on New Remote Directory Watcher from SFTP (password-based auth) API
SFTP (password-based auth) + GitHub
 
Try it
Get Issue Assignees with GitHub API on New Remote Directory Watcher from SFTP (password-based auth) API
SFTP (password-based auth) + GitHub
 
Try it
New Remote Directory Watcher from the SFTP (password-based auth) API

Emit new events when files get created, changed or deleted from a remote directory. See the docs

 
Try it
New Branch (Instant) from the GitHub API

Emit new events when a new branch is created

 
Try it
New Card in Column (Classic Projects) from the GitHub API

Emit new event when a (classic) project card is created or moved to a specific column. For Projects V2 use New Issue with Status trigger. More information here

 
Try it
New Collaborator (Instant) from the GitHub API

Emit new events when collaborators are added to a repo

 
Try it
New Commit (Instant) from the GitHub API

Emit new events on new commits to a repo or branch

 
Try it
Upload String as File with the SFTP (password-based auth) API

Uploads a UTF-8 string as a file on an SFTP server

 
Try it
Create Issue with the GitHub API

Create a new issue in a Gihub repo. See docs here

 
Try it
Search Issues and Pull Requests with the GitHub API

Find issues and pull requests by state and keyword. See docs here

 
Try it
Create Branch with the GitHub API

Create a new branch in a Github repo. See docs here

 
Try it
Create Issue Comment with the GitHub API

Create a new comment in a issue. See docs here

 
Try it