Skip to main content

Vercel

Vercel is a platform for frontend frameworks and static sites, providing deployment, preview environments, and edge functions. The Vercel REST API enables programmatic management of projects, deployments, teams, environment variables, domains, and Edge Config stores. Nexla connects to the Vercel API to ingest account resources and to push deployments and configuration changes as part of your data flows.

Vercel icon

Power end-to-end data operations for your Vercel API with Nexla. Our bi-directional Vercel connector is purpose-built for Vercel, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Vercel or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Vercel workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Vercel credential, you need a Vercel API access token. The Vercel REST API authenticates every request with a bearer token sent in the Authorization header, and all requests are made against the base URL https://api.vercel.com.

To create an access token, follow these steps:

  1. Sign in to your Vercel dashboard.

  2. Open your account settings and navigate to the Tokens page (Settings > Tokens).

  3. Click Create Token, then enter a descriptive name for the token (for example, "Nexla Integration").

  4. Choose the scope for the token. A token can be scoped to your personal account or to a specific team, which determines the resources the token can access.

  5. Select an expiration for the token, then click Create Token.

  6. Copy the generated token immediately and store it securely, as it is shown only once and cannot be retrieved again after you leave the page.

Many Vercel endpoints operate against a team's resources. When a token is scoped to a team, or when you need to target a team explicitly, resources are addressed using the team's identifier (the teamId query parameter). If your token is compromised, revoke it from the Tokens page in your Vercel account settings and create a new one. For detailed information about authentication and available endpoints, see the Vercel REST API documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API TokenYesYesVercel API token for authentication. Generate in Vercel dashboard under Settings > Tokens.
Base URLYesNoThe base URL for the Vercel API.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Vercel API token in the API Token field. This token is sent as a bearer token in the Authorization header for all requests to the Vercel API and must be kept confidential.

  4. Enter the API base URL in the Base URL field. This defaults to https://api.vercel.com and should only be changed if you have a specific reason to target a different host.

    If your API token is compromised, revoke it from the Tokens page in your Vercel account settings and generate a new one. The token grants access to your Vercel account resources based on its scope and should be treated as sensitive information.

    For detailed information about authentication, token scopes, and available endpoints, see the Vercel REST API documentation.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Vercel connector tile, then select the credential that will be used to connect to Vercel, and click Next; or, create a new Vercel credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Vercel endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Projects

Returns a paginated list of all projects in the account.

[Rest API] List Teams

Returns a paginated list of all teams in the account.

[Rest API] List Environment Variables

Returns a list of environment variables for a project.

  • Requires a Project ID — the unique identifier of the Vercel project whose environment variables will be retrieved.

[Rest API] List Authentication Tokens

Returns a paginated list of authentication tokens for the current user.

[Rest API] List Aliases

Returns a paginated list of all aliases across deployments.

[Rest API] List Deployment Events

Returns a paginated list of events for a specific deployment.

  • Requires a Deployment ID — the unique identifier of the deployment whose events will be retrieved.

[Rest API] List Team Members

Returns a paginated list of members for a specific team.

  • Requires a Team ID — the unique identifier of the team for which to list members.

[Rest API] Get the User

Retrieves the authenticated user's profile information from Vercel.

[Rest API] List deployments

Retrieves a list of deployments from the Vercel API. Optional filters — including project, application name, target environment, state, time range, and team — can be applied to narrow the results.

[Rest API] List Edge Configs

Retrieves a list of all edge configs for the account or team.

[Rest API] Get Edge Config

Retrieves metadata and configuration details for a specific edge config.

[Rest API] Get Edge Config Item

Retrieves a specific item from an edge config by key.

[Rest API] List Edge Config Items

Retrieves all items stored in a specific edge config.

[Rest API] Verify a login request to get an authentication token

Verifies a login token sent via email and returns an authentication token for API access.

[Rest API] Retrieve a list of all checks

Returns a list of all checks associated with a specific deployment.

[Rest API] List Integration Configurations

Retrieves a list of integration configurations for the authenticated user or team.

[Rest API] Find a project by ID or name

Retrieves a single project by its ID or name.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Vercel data sources can also be manually configured to ingest data from any valid Vercel REST API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Vercel data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Vercel destination, and select the Send to Destination option from the menu. Select the Vercel connector from the list of available destination connectors, then select the credential that will be used to connect to Vercel, and click Next; or, create a new Vercel credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Vercel endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Edge Config

Creates a new edge config with the specified slug and initial items.

[Rest API] Update Edge Config

Updates the slug or other metadata for an existing edge config.

[Rest API] Update Edge Config Items

Batch updates multiple items in an edge config in a single request.

[Rest API] Create Edge Config Token

Generates a new access token for reading a specific edge config.

  • Requires the edge config Id — the identifier of the edge config for which the token is created.

[Rest API] Login with email

Initiates an email-based login flow to request an authentication token.

  • Requires an Email address and a Token name for the authentication token being requested.

[Rest API] Create Deployment

Creates a new deployment with optional configuration for build, environment, and routing.

[Rest API] Create an Auth Token

Creates a new authentication token for API access.

[Rest API] Purchase a Domain

Purchases a domain at the expected price with optional automatic renewal.

[Rest API] Create a new project

Creates a new Vercel project with specified configuration and deployment settings.

[Rest API] Update an existing project

Updates configuration and settings for an existing Vercel project.

Manual configuration

Vercel destinations can also be manually configured to send data to any valid Vercel REST API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Vercel APIs expect JSON in the request body for create and update operations. Where an endpoint targets a team's resources, include the team identifier (the teamId query parameter) in the request.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Vercel endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Vercel endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.