New Deployment from Vercel API

Pipedream makes it easy to connect APIs for Vercel and 2,400+ other apps remarkably fast.

Trigger workflow on

New Deployment from the Vercel API

Next, do this

Connect to 2,400+ APIs using code and no-code building blocks

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#

Trigger a workflow on New Deployment with Vercel API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Add steps to connect to 2,400+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Generate PDF from HTML String with Browserless API on New Deployment from Vercel (Token Auth) API

Vercel + Browserless

Try it

Get Film with SWAPI - Star Wars API on New Deployment from Vercel API

Vercel + SWAPI - Star Wars

Try it

Run Go Code with Go API on New Deployment from Vercel (Token Auth) API

Vercel + Go

Try it

Run Python Code with Python API on New Deployment from Vercel (Token Auth) API

Vercel + Python

Try it

Send Message with Discord API on New Deployment from Vercel (Token Auth) API

Vercel + Discord

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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);
  },
};

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

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.