Vercel connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Set up the connector

   Register your Vercel credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

   Dashboard setup steps

   Register your Scalekit environment with the Vercel connector so Scalekit handles the OAuth flow and token lifecycle for your users. Follow every step below from start to finish — by the end you will have a working connection.

   1. Create a Vercel OAuth integration

      You need a Vercel OAuth integration to get the Client ID and Client Secret that Scalekit will use to authorize your users.

      Go to the Vercel Integrations Console:

      • Open vercel.com/dashboard/integrations/console in your browser and sign in.

      • Click Create Integration (top right of the page).

      • Fill in the form:

        Field	What to enter
        Integration Name	A recognizable name, e.g. My Vercel AI Agent
        URL Slug	Auto-generated from the name — you can leave it as-is
        Website URL	Your app’s public URL. For testing you can use https://localhost
        Short Description	Brief description of your integration

      • Leave the Redirects section empty for now. You will add the Scalekit callback URL in the next step.

      • Click Create →.

      After the integration is created, Vercel takes you to the integration’s settings page. Keep this tab open.

      

      Tip

      The Vercel integration is available for development immediately after creation — no marketplace publish step is required.

   2. Copy the redirect URI from Scalekit

      Scalekit gives you a callback URL that Vercel will redirect users back to after they authorize your app. You need to register this URL in your Vercel integration.

      In the Scalekit dashboard:

      • Go to app.scalekit.com and sign in.
      • In the left sidebar, click AgentKit > Connections > Create Connection.
      • Search for Vercel and click Create.
      • A connection details panel opens. Find the Redirect URI field — it looks like:

        https://<YOUR_ENV>.scalekit.cloud/sso/v1/oauth/conn_<ID>/callback

      • Click the copy icon next to the Redirect URI to copy it to your clipboard.

      

   3. Add the redirect URI and copy credentials from Vercel

      Switch back to the Vercel integration tab you left open.

      Register the redirect URI:

      • In the left sidebar of your integration settings, click Credentials.
      • Scroll down to the Redirect URIs section.
      • Paste the redirect URI you copied from Scalekit into the input field.
      • Click Add URI — the URI appears highlighted in the list.
      • Click Save Changes.

      Copy your credentials:

      • Scroll up to the OAuth Credentials section.
      • Client ID — shown in plain text. Click Copy ID to copy it.
      • Client Secret — click Reveal to show the secret, then copy it.

      Paste both values somewhere safe (a password manager or secrets vault). You will enter them into Scalekit in the next step.

      

      Caution

      The Client Secret is shown only when you click Reveal. If you lose it, you must generate a new one in the Vercel integration settings — this invalidates the old secret and all existing connections will stop working until you update them in Scalekit.

   4. Configure permissions in Vercel

      Permissions (scopes) control which Vercel API resources your integration can access on behalf of the user.

      • In the Vercel integration settings sidebar, click Permissions.

      • Enable the scopes your integration needs:

        Scope	Access granted
        openid	Required to issue an ID token for user identification
        email	User’s email address
        profile	User’s name, username, and profile picture
        offline_access	Refresh token for long-lived access without re-authorization

      • Click Save Changes.

      Tip

      Only enable scopes your integration actually uses. Users see a list of requested permissions on the authorization screen — fewer scopes increases trust and approval rates.

   5. Add credentials in Scalekit

      Switch back to the Scalekit dashboard tab.

      • Go to AgentKit > Connections and click the Vercel connection you created in Step 2.

      • Fill in the credentials form:

        Field	Value
        Client ID	Paste the Client ID from Step 3
        Client Secret	Paste the Client Secret from Step 3
        Scopes	Enter the scopes you enabled in Step 4, e.g. openid profile email offline_access

      • Click Save.

      

      Your Vercel connection is now configured. Scalekit will use these credentials to run the OAuth flow whenever a user connects their Vercel account.

      Tip

      The scopes entered here must match exactly what you enabled in Vercel. A mismatch causes an invalid_scope error when users try to authorize. If you add more scopes later, update both your Vercel integration and this Scalekit connection.

4. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'vercel'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Vercel:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'vercel_aliases_list',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "vercel"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Vercel:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="vercel_aliases_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Create env var, edge config, project — Creates a new environment variable for a Vercel project with the specified key, value, and target environments
• Add domain, project domain — Adds a domain to the authenticated user or team’s Vercel account
• Delete team, deployment, alias — Permanently deletes a Vercel team and all its associated resources
• List domains, team members, deployments — Returns all domains registered or added to the authenticated user or team’s Vercel account
• Get team, user, alias — Returns details of a specific Vercel team by its ID or slug
• Update edge config items, env var, project — Creates, updates, or deletes items in an Edge Config store using a list of patch operations

Common workflows

Proxy API call

Node.js

const result = await actions.request({
  connectionName: 'vercel',
  identifier: 'user_123',
  path: '/v2/user',
  method: 'GET',
});
console.log(result);

Python

result = actions.request(
    connection_name='vercel',
    identifier='user_123',
    path="/v2/user",
    method="GET"
)
print(result)

Execute a tool

Node.js

const result = await actions.executeTool({
  connector: 'vercel',
  identifier: 'user_123',
  toolName: 'vercel_alias_create',
  toolInput: {},
});
console.log(result);

Python

result = actions.execute_tool(
    tool_input={},
    tool_name='vercel_alias_create',
    connection_name='vercel',
    identifier='user_123',
)
print(result)

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

vercel_alias_create#Assigns an alias (custom domain) to a Vercel deployment.3 params▾

Assigns an alias (custom domain) to a Vercel deployment.

NameTypeRequiredDescription

aliasstringrequiredThe alias hostname to assign.

deployment_idstringrequiredThe deployment ID to assign the alias to.

team_idstringoptionalTeam ID if the deployment belongs to a team.

vercel_alias_delete#Removes an alias from a Vercel deployment.2 params▾

Removes an alias from a Vercel deployment.

NameTypeRequiredDescription

alias_or_idstringrequiredThe alias hostname or ID to delete.

team_idstringoptionalTeam ID if the alias belongs to a team.

vercel_alias_get#Returns information about a specific alias by its ID or hostname.2 params▾

Returns information about a specific alias by its ID or hostname.

NameTypeRequiredDescription

alias_or_idstringrequiredThe alias hostname or ID.

team_idstringoptionalTeam ID if the alias belongs to a team.

vercel_aliases_list#Returns all aliases for the authenticated user or team, with optional domain and deployment filtering.4 params▾

Returns all aliases for the authenticated user or team, with optional domain and deployment filtering.

NameTypeRequiredDescription

domainstringoptionalFilter aliases by domain.

limitintegeroptionalMaximum number of aliases to return.

sinceintegeroptionalTimestamp in ms for pagination.

team_idstringoptionalTeam ID to list aliases for.

vercel_check_create#Creates a new check on a Vercel deployment. Used by integrations to report status of external checks like test suites or audits.5 params▾

Creates a new check on a Vercel deployment. Used by integrations to report status of external checks like test suites or audits.

NameTypeRequiredDescription

blockingbooleanrequiredIf true, this check must pass before deployment is considered ready.

deployment_idstringrequiredThe deployment ID to create a check for.

namestringrequiredDisplay name for the check.

detailsUrlstringoptionalURL where users can view check details.

team_idstringoptionalTeam ID if the deployment belongs to a team.

vercel_check_update#Updates the status and conclusion of a deployment check. Used to report check results back to Vercel.6 params▾

Updates the status and conclusion of a deployment check. Used to report check results back to Vercel.

NameTypeRequiredDescription

check_idstringrequiredThe check ID to update.

deployment_idstringrequiredThe deployment ID the check belongs to.

conclusionstringoptionalCheck conclusion: succeeded, failed, skipped, canceled.

detailsUrlstringoptionalURL where users can view check details.

statusstringoptionalCheck status: running, completed.

team_idstringoptionalTeam ID if the deployment belongs to a team.

vercel_checks_list#Returns all checks attached to a Vercel deployment (e.g. from third-party integrations).2 params▾

Returns all checks attached to a Vercel deployment (e.g. from third-party integrations).

NameTypeRequiredDescription

deployment_idstringrequiredThe deployment ID to list checks for.

team_idstringoptionalTeam ID if the deployment belongs to a team.

vercel_deployment_aliases_list#Returns all aliases assigned to a specific Vercel deployment.2 params▾

Returns all aliases assigned to a specific Vercel deployment.

NameTypeRequiredDescription

deployment_idstringrequiredThe deployment ID to get aliases for.

team_idstringoptionalTeam ID if the deployment belongs to a team.

vercel_deployment_cancel#Cancels a Vercel deployment that is currently building or queued.2 params▾

Cancels a Vercel deployment that is currently building or queued.

NameTypeRequiredDescription

deployment_idstringrequiredThe deployment ID to cancel.

team_idstringoptionalTeam ID if the deployment belongs to a team.

vercel_deployment_create#Creates a new Vercel deployment for a project, optionally from a Git ref or with inline files.4 params▾

Creates a new Vercel deployment for a project, optionally from a Git ref or with inline files.

NameTypeRequiredDescription

namestringrequiredThe project name to deploy.

git_sourcestringoptionalJSON object with Git source info, e.g. {"type":"github","ref":"main","repoId":"123"}.

targetstringoptionalDeployment target: production or preview. Default is preview.

team_idstringoptionalTeam ID if deploying to a team project.

vercel_deployment_delete#Deletes a Vercel deployment by its ID.2 params▾

Deletes a Vercel deployment by its ID.

NameTypeRequiredDescription

deployment_idstringrequiredThe deployment ID to delete.

team_idstringoptionalTeam ID if the deployment belongs to a team.

vercel_deployment_events_list#Returns build log events for a Vercel deployment. Useful for debugging build errors.4 params▾

Returns build log events for a Vercel deployment. Useful for debugging build errors.

NameTypeRequiredDescription

deployment_idstringrequiredThe deployment ID to get events for.

limitintegeroptionalMaximum number of log events to return.

sinceintegeroptionalTimestamp in ms to fetch events after.

team_idstringoptionalTeam ID if the deployment belongs to a team.

vercel_deployment_get#Returns details of a specific Vercel deployment by its ID or URL, including build status, target, and metadata.2 params▾

Returns details of a specific Vercel deployment by its ID or URL, including build status, target, and metadata.

NameTypeRequiredDescription

id_or_urlstringrequiredThe deployment ID (dpl_xxx) or deployment URL.

team_idstringoptionalTeam ID if the deployment belongs to a team.

vercel_deployments_list#Returns a list of deployments for the authenticated user or a specific project/team, with filtering and pagination.6 params▾

Returns a list of deployments for the authenticated user or a specific project/team, with filtering and pagination.

NameTypeRequiredDescription

fromintegeroptionalTimestamp in ms for pagination cursor.

limitintegeroptionalMaximum number of deployments to return.

project_idstringoptionalFilter deployments by project ID or name.

statestringoptionalFilter by deployment state: BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED.

targetstringoptionalFilter by target environment: production or preview.

team_idstringoptionalFilter deployments by team ID.

vercel_dns_record_create#Creates a new DNS record for a domain managed by Vercel. Supports A, AAAA, CNAME, TXT, MX, SRV, and CAA records.7 params▾

Creates a new DNS record for a domain managed by Vercel. Supports A, AAAA, CNAME, TXT, MX, SRV, and CAA records.

NameTypeRequiredDescription

domainstringrequiredThe domain to create the DNS record for.

namestringrequiredSubdomain name, or empty string for root domain.

typestringrequiredRecord type: A, AAAA, CNAME, TXT, MX, SRV, CAA.

valuestringrequiredThe record value (IP address, hostname, text, etc.).

mx_priorityintegeroptionalPriority for MX records.

team_idstringoptionalTeam ID if the domain belongs to a team.

ttlintegeroptionalTime-to-live in seconds. Default is 60.

vercel_dns_record_delete#Deletes a DNS record from a domain managed by Vercel.3 params▾

Deletes a DNS record from a domain managed by Vercel.

NameTypeRequiredDescription

domainstringrequiredThe domain the DNS record belongs to.

record_idstringrequiredThe ID of the DNS record to delete.

team_idstringoptionalTeam ID if the domain belongs to a team.

vercel_dns_records_list#Returns all DNS records for a domain managed by Vercel.4 params▾

Returns all DNS records for a domain managed by Vercel.

NameTypeRequiredDescription

domainstringrequiredThe domain to list DNS records for.

limitintegeroptionalMaximum number of records to return.

sinceintegeroptionalTimestamp in ms for pagination.

team_idstringoptionalTeam ID if the domain belongs to a team.

vercel_domain_add#Adds a domain to the authenticated user or team's Vercel account.2 params▾

Adds a domain to the authenticated user or team's Vercel account.

NameTypeRequiredDescription

namestringrequiredThe domain name to add.

team_idstringoptionalTeam ID to add the domain to.

vercel_domain_delete#Removes a domain from the authenticated user or team's Vercel account.2 params▾

Removes a domain from the authenticated user or team's Vercel account.

NameTypeRequiredDescription

domainstringrequiredThe domain name to delete.

team_idstringoptionalTeam ID if the domain belongs to a team.

vercel_domain_get#Returns information about a specific domain including verification status, nameservers, and registrar.2 params▾

Returns information about a specific domain including verification status, nameservers, and registrar.

NameTypeRequiredDescription

domainstringrequiredThe domain name to look up.

team_idstringoptionalTeam ID if the domain belongs to a team.

vercel_domains_list#Returns all domains registered or added to the authenticated user or team's Vercel account.3 params▾

Returns all domains registered or added to the authenticated user or team's Vercel account.

NameTypeRequiredDescription

limitintegeroptionalMaximum number of domains to return.

sinceintegeroptionalTimestamp in ms for pagination.

team_idstringoptionalTeam ID to list domains for.

vercel_edge_config_create#Creates a new Edge Config store for storing read-only configuration data close to users at the edge.2 params▾

Creates a new Edge Config store for storing read-only configuration data close to users at the edge.

NameTypeRequiredDescription

slugstringrequiredA unique slug for the Edge Config store.

team_idstringoptionalTeam ID to create the Edge Config under.

vercel_edge_config_delete#Permanently deletes an Edge Config store and all its items.2 params▾

Permanently deletes an Edge Config store and all its items.

NameTypeRequiredDescription

edge_config_idstringrequiredThe Edge Config store ID to delete.

team_idstringoptionalTeam ID if the Edge Config belongs to a team.

vercel_edge_config_get#Returns details of a specific Edge Config store by its ID.2 params▾

Returns details of a specific Edge Config store by its ID.

NameTypeRequiredDescription

edge_config_idstringrequiredThe Edge Config store ID.

team_idstringoptionalTeam ID if the Edge Config belongs to a team.

vercel_edge_config_item_get#Returns the value of a specific item from an Edge Config store by key.3 params▾

Returns the value of a specific item from an Edge Config store by key.

NameTypeRequiredDescription

edge_config_idstringrequiredThe Edge Config store ID.

item_keystringrequiredThe key of the item to retrieve.

team_idstringoptionalTeam ID if the Edge Config belongs to a team.

vercel_edge_config_items_list#Returns all key-value items stored in an Edge Config store.2 params▾

Returns all key-value items stored in an Edge Config store.

NameTypeRequiredDescription

edge_config_idstringrequiredThe Edge Config store ID.

team_idstringoptionalTeam ID if the Edge Config belongs to a team.

vercel_edge_config_items_update#Creates, updates, or deletes items in an Edge Config store using a list of patch operations.3 params▾

Creates, updates, or deletes items in an Edge Config store using a list of patch operations.

NameTypeRequiredDescription

edge_config_idstringrequiredThe Edge Config store ID.

itemsstringrequiredJSON array of patch operations. Each item has 'operation' (create/update/upsert/delete), 'key', and optionally 'value'.

team_idstringoptionalTeam ID if the Edge Config belongs to a team.

vercel_edge_config_token_create#Creates a new read token for an Edge Config store to be used in application code.3 params▾

Creates a new read token for an Edge Config store to be used in application code.

NameTypeRequiredDescription

edge_config_idstringrequiredThe Edge Config store ID.

labelstringrequiredA descriptive label for the token.

team_idstringoptionalTeam ID if the Edge Config belongs to a team.

vercel_edge_config_tokens_delete#Deletes one or more read tokens from an Edge Config store.3 params▾

Deletes one or more read tokens from an Edge Config store.

NameTypeRequiredDescription

edge_config_idstringrequiredThe Edge Config store ID.

tokensstringrequiredJSON array of token IDs to delete.

team_idstringoptionalTeam ID if the Edge Config belongs to a team.

vercel_edge_config_tokens_list#Returns all read tokens for an Edge Config store.2 params▾

Returns all read tokens for an Edge Config store.

NameTypeRequiredDescription

edge_config_idstringrequiredThe Edge Config store ID.

team_idstringoptionalTeam ID if the Edge Config belongs to a team.

vercel_edge_configs_list#Returns all Edge Config stores for the authenticated user or team.1 param▾

Returns all Edge Config stores for the authenticated user or team.

NameTypeRequiredDescription

team_idstringoptionalTeam ID to list Edge Configs for.

vercel_env_var_create#Creates a new environment variable for a Vercel project with the specified key, value, and target environments.6 params▾

Creates a new environment variable for a Vercel project with the specified key, value, and target environments.

NameTypeRequiredDescription

id_or_namestringrequiredThe project ID or name.

keystringrequiredThe environment variable key.

valuestringrequiredThe environment variable value.

targetstringoptionalJSON array of targets: production, preview, development. Defaults to all.

team_idstringoptionalTeam ID if the project belongs to a team.

typestringoptionalVariable type: plain or secret. Default is plain.

vercel_env_var_delete#Deletes an environment variable from a Vercel project.3 params▾

Deletes an environment variable from a Vercel project.

NameTypeRequiredDescription

env_idstringrequiredThe environment variable ID to delete.

id_or_namestringrequiredThe project ID or name.

team_idstringoptionalTeam ID if the project belongs to a team.

vercel_env_var_update#Updates an existing environment variable for a Vercel project.5 params▾

Updates an existing environment variable for a Vercel project.

NameTypeRequiredDescription

env_idstringrequiredThe environment variable ID to update.

id_or_namestringrequiredThe project ID or name.

targetstringoptionalJSON array of new targets: production, preview, development.

team_idstringoptionalTeam ID if the project belongs to a team.

valuestringoptionalNew value for the environment variable.

vercel_env_vars_list#Returns all environment variables for a Vercel project, including their targets (production, preview, development) and encryption status.3 params▾

Returns all environment variables for a Vercel project, including their targets (production, preview, development) and encryption status.

NameTypeRequiredDescription

id_or_namestringrequiredThe project ID or name.

decryptbooleanoptionalIf true, returns decrypted values for sensitive variables.

team_idstringoptionalTeam ID if the project belongs to a team.

vercel_project_create#Creates a new Vercel project with a given name, framework, and optional Git repository.5 params▾

Creates a new Vercel project with a given name, framework, and optional Git repository.

NameTypeRequiredDescription

namestringrequiredThe name of the project.

frameworkstringoptionalFramework preset, e.g. nextjs, vite, gatsby, nuxtjs, create-react-app.

git_repositorystringoptionalJSON object with 'type' (github/gitlab/bitbucket) and 'repo' (owner/name) fields.

root_directorystringoptionalRoot directory of the project within the repository.

team_idstringoptionalTeam ID to create the project under.

vercel_project_delete#Permanently deletes a Vercel project and all its deployments, domains, and environment variables.2 params▾

Permanently deletes a Vercel project and all its deployments, domains, and environment variables.

NameTypeRequiredDescription

id_or_namestringrequiredThe project ID or name to delete.

team_idstringoptionalTeam ID if the project belongs to a team.

vercel_project_domain_add#Assigns a domain to a Vercel project with an optional redirect target.5 params▾

Assigns a domain to a Vercel project with an optional redirect target.

NameTypeRequiredDescription

id_or_namestringrequiredThe project ID or name.

namestringrequiredThe domain name to assign to the project.

git_branchstringoptionalGit branch to associate this domain with for preview deployments.

redirectstringoptionalRedirect target domain if this domain should redirect.

team_idstringoptionalTeam ID if the project belongs to a team.

vercel_project_domain_delete#Removes a domain assignment from a Vercel project.3 params▾

Removes a domain assignment from a Vercel project.

NameTypeRequiredDescription

domainstringrequiredThe domain name to remove from the project.

id_or_namestringrequiredThe project ID or name.

team_idstringoptionalTeam ID if the project belongs to a team.

vercel_project_domains_list#Returns all domains assigned to a specific Vercel project.3 params▾

Returns all domains assigned to a specific Vercel project.

NameTypeRequiredDescription

id_or_namestringrequiredThe project ID or name.

productionbooleanoptionalFilter to production domains only.

team_idstringoptionalTeam ID if the project belongs to a team.

vercel_project_get#Returns details of a specific Vercel project including its framework, Git repository, environment variables summary, and domains.2 params▾

Returns details of a specific Vercel project including its framework, Git repository, environment variables summary, and domains.

NameTypeRequiredDescription

id_or_namestringrequiredThe project ID or name.

team_idstringoptionalTeam ID if the project belongs to a team.

vercel_project_update#Updates a Vercel project's name, framework, build command, output directory, or other settings.7 params▾

Updates a Vercel project's name, framework, build command, output directory, or other settings.

NameTypeRequiredDescription

id_or_namestringrequiredThe project ID or name to update.

build_commandstringoptionalCustom build command override.

frameworkstringoptionalFramework preset to apply.

install_commandstringoptionalCustom install command override.

namestringoptionalNew project name.

output_directorystringoptionalCustom output directory override.

team_idstringoptionalTeam ID if the project belongs to a team.

vercel_projects_list#Returns all projects for the authenticated user or team, with optional search and pagination.4 params▾

Returns all projects for the authenticated user or team, with optional search and pagination.

NameTypeRequiredDescription

fromintegeroptionalTimestamp in ms for pagination cursor.

limitintegeroptionalMaximum number of projects to return.

searchstringoptionalFilter projects by name search query.

team_idstringoptionalTeam ID to list projects for. Omit for personal projects.

vercel_team_create#Creates a new Vercel team with the specified slug and optional name.2 params▾

Creates a new Vercel team with the specified slug and optional name.

NameTypeRequiredDescription

slugstringrequiredA unique URL-friendly identifier for the team.

namestringoptionalDisplay name for the team.

vercel_team_delete#Permanently deletes a Vercel team and all its associated resources.1 param▾

Permanently deletes a Vercel team and all its associated resources.

NameTypeRequiredDescription

team_idstringrequiredThe team ID or slug to delete.

vercel_team_get#Returns details of a specific Vercel team by its ID or slug.1 param▾

Returns details of a specific Vercel team by its ID or slug.

NameTypeRequiredDescription

team_idstringrequiredThe team ID or slug.

vercel_team_member_invite#Invites a user to a Vercel team by email address with a specified role.3 params▾

Invites a user to a Vercel team by email address with a specified role.

NameTypeRequiredDescription

emailstringrequiredEmail address of the user to invite.

team_idstringrequiredThe team ID or slug.

rolestringoptionalRole to assign: OWNER, MEMBER, VIEWER, DEVELOPER, BILLING.

vercel_team_member_remove#Removes a member from a Vercel team by their user ID.2 params▾

Removes a member from a Vercel team by their user ID.

NameTypeRequiredDescription

team_idstringrequiredThe team ID or slug.

user_idstringrequiredThe user ID of the member to remove.

vercel_team_members_list#Returns all members of a Vercel team including their roles and join dates.4 params▾

Returns all members of a Vercel team including their roles and join dates.

NameTypeRequiredDescription

team_idstringrequiredThe team ID or slug.

limitintegeroptionalMaximum number of members to return.

rolestringoptionalFilter by role: OWNER, MEMBER, VIEWER, DEVELOPER, BILLING.

sinceintegeroptionalTimestamp in ms to fetch members joined after this time.

vercel_team_update#Updates a Vercel team's name, slug, description, or other settings.4 params▾

Updates a Vercel team's name, slug, description, or other settings.

NameTypeRequiredDescription

team_idstringrequiredThe team ID or slug to update.

descriptionstringoptionalNew description for the team.

namestringoptionalNew display name for the team.

slugstringoptionalNew URL-friendly slug for the team.

vercel_teams_list#Returns all teams the authenticated user belongs to, with pagination support.3 params▾

Returns all teams the authenticated user belongs to, with pagination support.

NameTypeRequiredDescription

limitintegeroptionalMaximum number of teams to return.

sinceintegeroptionalTimestamp in milliseconds to fetch teams created after this time.

untilintegeroptionalTimestamp in milliseconds to fetch teams created before this time.

vercel_user_get#Returns the authenticated user's profile including name, email, username, and account details.0 params▾

Returns the authenticated user's profile including name, email, username, and account details.

vercel_webhook_create#Creates a new webhook that sends event notifications to the specified URL for Vercel deployment and project events.4 params▾

Creates a new webhook that sends event notifications to the specified URL for Vercel deployment and project events.

NameTypeRequiredDescription

eventsstringrequiredJSON array of event types to subscribe to, e.g. ["deployment.created","deployment.succeeded"].

urlstringrequiredThe HTTPS endpoint URL to receive webhook payloads.

project_idsstringoptionalJSON array of project IDs to scope this webhook to. Omit for all projects.

team_idstringoptionalTeam ID to create the webhook for.

vercel_webhook_delete#Permanently deletes a Vercel webhook.2 params▾

Permanently deletes a Vercel webhook.

NameTypeRequiredDescription

webhook_idstringrequiredThe webhook ID to delete.

team_idstringoptionalTeam ID if the webhook belongs to a team.

vercel_webhook_get#Returns details of a specific Vercel webhook by its ID.2 params▾

Returns details of a specific Vercel webhook by its ID.

NameTypeRequiredDescription

webhook_idstringrequiredThe webhook ID.

team_idstringoptionalTeam ID if the webhook belongs to a team.

vercel_webhooks_list#Returns all webhooks configured for the authenticated user or team.1 param▾

Returns all webhooks configured for the authenticated user or team.

NameTypeRequiredDescription

team_idstringoptionalTeam ID to list webhooks for.