Vercel

Manage deployments and projects on Vercel.

Developer toolsAPI key6 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (6)
create_deployment
list_projects
custom_api_call
get_deployment_status
list_environment_variables
upsert_environment_variable
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("vercel", "create_deployment", {
    "project": "<project>",
    "deployment_source": "redeploy"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Vercel answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "vercel-create-deployment",
  name: "Vercel: Create Deployment",
  description: "Calls Vercel when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("vercel", {
      "action": "create_deployment",
      "project": "<project>",
      "deployment_source": "redeploy"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/vercel/create_deployment" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"project":"<project>","deployment_source":"redeploy"}}'

Actions

create_deploymentin catalog

Create Deployment. Create a deployment for an existing Vercel project using either a redeploy source deployment ID or a git source payload.

Input	Type	Description
`project`required	id (picked from your account)	Select a Vercel project.
`deployment_source`required	one of "redeploy" \| "git_source"	Choose whether to redeploy a previous deployment or deploy from a connected Git source.
`source_fields`optional	object (depends on other props)	Source Configuration
`force_new`optional	boolean	Create a new deployment even if a previous similar deployment exists.
`skip_auto_detection_confirmation`optional	boolean	Automatically confirm framework detection without prompting.

list_projectsin catalog

List Projects. Retrieve all Vercel projects for the authenticated user or team.

Input	Type	Description
`search`optional	text	Filter projects by name.

custom_api_call

Custom API Call. Make a custom API call to Vercel. The Authorization header is injected automatically. If your connection uses Team ID or Team Slug, add `teamId` or `slug` manually in the URL or Query Parameters for team-scoped requests.

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Optional query parameters. For team-scoped requests, manually include `teamId` or `slug` here when needed.
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

get_deployment_status

Get Deployment Status. Retrieve a deployment and inspect its current status.

Input	Type	Description
`project`required	id (picked from your account)	Select a Vercel project.
`deployment`required	id (picked from your account)	Select the deployment to inspect.
`with_git_repo_info`optional	boolean	Adds gitRepo information when available.

list_environment_variables

List Environment Variables. Retrieve environment variables for a Vercel project.

Input	Type	Description
`project`required	id (picked from your account)	Select a Vercel project.
`decrypt`optional	boolean	Deprecated by Vercel. If enabled, Vercel will attempt to return decrypted values when allowed.
`git_branch`optional	text	Optional branch filter. Only valid for preview-scoped variables.

upsert_environment_variable

Upsert Environment Variable. Create or update a Vercel environment variable using Vercel's upsert API.

Input	Type	Description
`project`required	id (picked from your account)	Select a Vercel project.
`key`required	text	Environment variable key.
`value`required	long text	Environment variable value.
`type`required	one of "plain" \| "sensitive" \| "encrypted"	Vercel environment variable type.
`target`required	list of	Environment(s) where this variable should apply.
`git_branch`optional	text	Optional branch. Only valid when Preview is one of the selected targets.
`comment`optional	text	Optional note describing the variable usage.

Details

Id: vercel
Category: Developer tools
Tags: hosting, deployment, serverless, frontend
Package: @activepieces/piece-vercel@0.0.1
Tier: Community