Execute a Command with SSH (key-based auth) API on New Deployment from Vercel API

Pipedream makes it easy to connect APIs for SSH (key-based auth), Vercel and 2,200+ other apps remarkably fast.

Trigger workflow on

New Deployment from the Vercel API

Next, do this

Execute a Command with the SSH (key-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 SSH (key-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 Execute a Command action
1. Connect your SSH (key-based auth) account
2. Configure Command
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#

Execute a Command on SSH (key-based auth)

Description:Executes a command on a remote device. [See SSH lib docs here](https://www.npmjs.com/package/node-ssh)

Version:0.0.2

Key:ssh-execute-command

View on GitHub

SSH (key-based auth) Overview#

The SSH (Secure Shell) key-based authentication API allows you to execute commands on a remote server securely. With Pipedream, leverage this capability to automate server management tasks, execute deployment scripts, or gather data from your server infrastructure. By integrating with other apps on Pipedream, you can create seamless workflows that trigger actions on your servers in response to various events.

Action Code#

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

export default {
  type: "action",
  key: "ssh-execute-command",
  name: "Execute a Command",
  description: "Executes a command on a remote device. [See SSH lib docs here](https://www.npmjs.com/package/node-ssh)",
  version: "0.0.2",
  props: {
    ssh,
    command: {
      label: "Command",
      description: "Command that will be executed",
      type: "string",
    },
  },
  async run({ $ }) {
    const response = await this.ssh.executeCommand({
      command: this.command,
    });

    $.export("$summary", "Successfully executed command");

    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.

Label	Prop	Type	Description
SSH (key-based auth)	`ssh`	`app`	This component uses the SSH (key-based auth) app.
Command	`command`	`string`	Command that will be executed

Action Authentication#

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

Enter the hostname and port of the server you'd like to connect to, your username, and the private key you'd like to use to connect.

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