← Vercel (OAuth)

Create Deployment with Vercel (OAuth) API

Pipedream makes it easy to connect APIs for Vercel (OAuth) and 900+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Deployment with the Vercel (OAuth) API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Create Deployment with the Vercel (OAuth) API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create Deployment action
    1. Connect your Vercel (OAuth) account
    2. Configure Name
    3. Optional- Select a Project
    4. Configure Git Source Repository Id
    5. Configure Branch
    6. Optional- Select a Team
    7. Optional- Configure Public
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Deployment with Vercel API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Vercel (OAuth)
 
Try it
Create Deployment with Vercel API on New Item in Feed from RSS API
RSS + Vercel (OAuth)
 
Try it
Create Deployment with Vercel API on New Message from Discord API
Discord + Vercel (OAuth)
 
Try it
Create Deployment with Vercel API on New Message In Channels from Slack API
Slack + Vercel (OAuth)
 
Try it
Create Deployment with Vercel API on New Message in Channel from Discord Bot API
Discord Bot + Vercel (OAuth)
 
Try it

Details

This is a pre-built, open source 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.

Create Deployment on Vercel (OAuth)
Description:Create a new deployment from a GitHub repository. [See the docs](https://vercel.com/docs/rest-api#endpoints/deployments/create-a-new-deployment)
Version:0.0.2
Key:vercel-create-deployment

Code

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

export default {
  key: "vercel-create-deployment",
  name: "Create Deployment",
  description: "Create a new deployment from a GitHub repository. [See the docs](https://vercel.com/docs/rest-api#endpoints/deployments/create-a-new-deployment)",
  version: "0.0.2",
  type: "action",
  props: {
    vercel,
    name: {
      type: "string",
      label: "Name",
      description: "A string with the project name used in the deployment URL",
    },
    project: {
      propDefinition: [
        vercel,
        "project",
      ],
      description: "The target project identifier in which the deployment will be created. When defined, this parameter overrides name",
    },
    repoId: {
      type: "string",
      label: "Git Source Repository Id",
      description: "Id of the source repository",
    },
    branch: {
      type: "string",
      label: "Branch",
      description: "Branch of repository to deploy to",
      default: "main",
    },
    team: {
      propDefinition: [
        vercel,
        "team",
      ],
    },
    public: {
      type: "boolean",
      label: "Public",
      description: "Whether a deployment's source and logs are available publicly",
      optional: true,
    },
  },
  async run({ $ }) {
    const data = {
      name: this.name,
      project: this.project,
      teamId: this.team,
      public: this.public,
      gitSource: {
        type: "github",
        repoId: this.repoId,
        ref: this.branch,
      },
    };
    const res = await this.vercel.createDeployment(data, $);
    $.export("$summary", "Successfully created new deployment");
    return res;
  },
};

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
Vercel (OAuth)vercelappThis component uses the Vercel (OAuth) app.
Namenamestring

A string with the project name used in the deployment URL

ProjectprojectstringSelect a value from the drop down menu.
Git Source Repository IdrepoIdstring

Id of the source repository

Branchbranchstring

Branch of repository to deploy to

TeamteamstringSelect a value from the drop down menu.
Publicpublicboolean

Whether a deployment's source and logs are available publicly

Authentication

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

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

About Vercel (OAuth)

The easiest way to deploy websites

More Ways to Use Vercel (OAuth)

Triggers

New Deployment from the Vercel (OAuth) API

Emit new event when a deployment is created

 
Try it

Actions

Cancel Deployment with the Vercel (OAuth) API

Cancel a deployment which is currently building. See the docs

 
Try it
List Deployments with the Vercel (OAuth) API

List deployments under the account corresponding to the API token. See the docs

 
Try it