Reference
Vercel
Move environment variables to and from a Vercel project.
Move environment variables to and from a Vercel project.
Connection
| What | This provider |
|---|---|
| Vendor | Vercel |
| Key | vercel-env |
| Availability | available. You can connect it today. |
| Credential we hold | vercel-token |
| Values read back | yes |
| Activation | on-next-deploy |
Directions
| Direction | What it does |
|---|---|
import | We read names and values out of the store into your environment. |
export | We write names and values from your environment into the store. |
Activation
on-next-deploy. A new value waits there and arrives with your next deploy.
Conflict policies
| Direction | Policies you can pick |
|---|---|
import | skip_existing, new_version, fail |
export | create_only, overwrite, overwrite_and_prune |
How syncs work says what each one does.
Connect
Paste a credential from the vendor. We seal it and never show it again.
| Field | Label | Kind | Required | What it is |
|---|---|---|---|---|
token | Access token | secret; we mask it here and seal it | yes |
Connection fields
You set these when you connect. Every mapping on the connection shares them.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
teamId | Team ID | text | no | yes | Only for a team account. Leave empty to use the token's own scope. |
Mapping fields
You answer these once per environment you map.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
projectId | Project | text | yes | no | The project whose variables this environment maps onto. |
target | Deployments | choice | yes | yes | Which deployments read these variables. One of Production, Preview, Development. Starts at production. |
gitBranch | Git branch | text | no | yes | Preview only: pin the variables to one branch. |
customEnvironmentId | Custom environment | text | no | yes | Adds this environment to the deployments above; one variable serves both. Inside one, VERCEL_ENV reads preview and the name is in VERCEL_TARGET_ENV. |
Required permissions
We probe for these when we verify the connection.
| Permission | Directions | Blocking | Without it |
|---|---|---|---|
user:read | every direction | yes | We cannot confirm which Vercel account this token belongs to. |
projects:read | every direction | yes | Preview cannot list the project's variable names. |
env:read | import | yes | Import cannot read variable values. |
env:write | export | yes | Export cannot write anything. |