Upload String as File with SFTP (password-based auth) API on New Deployment from Vercel API

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

Trigger workflow on

New Deployment from the Vercel API

Next, do this

Upload String as File with the SFTP (password-based auth) 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 Vercel trigger and SFTP (password-based auth) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Deployment trigger
1. Connect your Vercel account
2. Configure timer
3. Optional- Select a Project
4. Optional- Select a State
5. Optional- Configure Max
Configure the Upload String as File action
1. Connect your SFTP (password-based auth) account
2. Configure data
3. Configure Remote 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 Deployment on Vercel

Description:Emit new event when a deployment is created

Version:0.0.3

Key:vercel_token_auth-new-deployment

View on GitHub

Vercel Overview#

The Vercel API empowers developers to automate, manage, and interact with their Vercel projects and deployments directly through code. With the Vercel API on Pipedream, you can harness the power of serverless functions to create dynamic and responsive workflows. Automate deployment processes, sync deployment statuses with other tools, trigger notifications based on deployment events, or manage your domains and aliases—all within the seamless integration landscape of Pipedream.

Trigger Code#

import vercelTokenAuth from "../../vercel_token_auth.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "vercel_token_auth-new-deployment",
  name: "New Deployment",
  description: "Emit new event when a deployment is created",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  props: {
    vercelTokenAuth,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    project: {
      propDefinition: [
        vercelTokenAuth,
        "project",
      ],
    },
    state: {
      propDefinition: [
        vercelTokenAuth,
        "state",
      ],
    },
    max: {
      propDefinition: [
        vercelTokenAuth,
        "max",
      ],
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(10);
    },
  },
  methods: {
    _getFrom() {
      return this.db.get("from");
    },
    _setFrom(from) {
      this.db.set("from", from);
    },
    generateMeta(deployment) {
      const {
        uid,
        name,
        state,
        created,
      } = deployment;
      return {
        id: uid,
        summary: `${name ?? uid} ${state}`,
        ts: created,
      };
    },
    async processEvent(max) {
      const params = {
        projectId: this.project,
        state: this.state,
      };
      let from = this._getFrom();
      if (from) {
        params.from = from;
      }
      const deployments = await this.vercelTokenAuth.listDeployments(params, max);
      for (const deployment of deployments) {
        if (!from || deployment.created > from) {
          from = deployment.created;
        }
        const meta = this.generateMeta(deployment);
        this.$emit(deployment, meta);
      }
      this._setFrom(from);
    },
  },
  async run() {
    await this.processEvent(this.max);
  },
};

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
Vercel	`vercelTokenAuth`	`app`	This component uses the Vercel app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Project	`project`	`string`	Select a value from the drop down menu.
State	`state`	`string`	Select a value from the drop down menu:`BUILDINGERRORINITIALIZINGQUEUEDREADYCANCELED`
Max	`max`	`integer`	Maximum number of results to return

Trigger Authentication#

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

Vercel encourages users to connect their account with Pipedream using Personal Access Tokens, which can be managed in your Vercel account here.

To learn more, refer to Vercel's documentation.

About Vercel#

Vercel is the platform for frontend developers, providing the speed and reliability innovators need to create at the moment of inspiration.

Action#

Upload String as File on SFTP (password-based auth)

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

Version:0.1.1

Key:sftp_password_based_auth-upload-file

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.

Action Code#

// legacy_hash_id: a_YEikdQ
import Client from "ssh2-sftp-client";

export default {
  key: "sftp_password_based_auth-upload-file",
  name: "Upload String as File",
  description: "Uploads a UTF-8 string as a file on an SFTP server",
  version: "0.1.1",
  type: "action",
  props: {
    sftp_password_based_auth: {
      type: "app",
      app: "sftp_password_based_auth",
    },
    data: {
      type: "string",
      description: "A UTF-8 string to upload as a file on the remote server.",
    },
    remotePath: {
      type: "string",
      label: "Remote Path",
      description: "The path to the remote file to be created on the server.",
    },
  },
  async run({ $ }) {
    const {
      host,
      username,
      password,
    } = this.sftp_password_based_auth.$auth;

    const config = {
      host,
      username,
      password,
    };

    const sftp = new Client();

    await sftp.connect(config);
    $.export("putResponse", await sftp.put(Buffer.from(this.data), this.remotePath));
    await sftp.end();
  },
};

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
SFTP (password-based auth)	`sftp_password_based_auth`	`app`	This component uses the SFTP (password-based auth) app.
data	`data`	`string`	A UTF-8 string to upload as a file on the remote server.
Remote Path	`remotePath`	`string`	The path to the remote file to be created on the server.

Action 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.