Reference
Convex
Sync a penv environment with a Convex deployment's environment variables.
Sync a penv environment with a Convex deployment's environment variables.
The connection
| What | This provider |
|---|---|
| Vendor | Convex |
| Key | convex-deployment-env |
| Availability | available. You can connect it today. |
| Credential penv holds | convex-token |
| Values read back | yes |
| Activation | immediate |
What it moves
| Direction | What it does |
|---|---|
import | Reads names and values out of the store into penv. |
export | Writes names and values from penv into the store. |
When a written value goes live
immediate. The running app sees a new value at once.
What happens to a name that exists
| 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.
How you connect
You paste a credential you already hold. penv seals it and never shows it again.
| Field | Label | Kind | Required | What it is |
|---|---|---|---|---|
token | Token | secret, masked here and sealed | yes | A deployment key or team access token. |
What the connection asks for
Fixed when you connect, and shared by every mapping on it.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
deploymentName | Deployment | text | yes | no | The deployment name from your Convex dashboard URL. We only ever call convex.cloud. |
Permissions it needs
penv probes for these when it verifies the connection.
| Permission | Directions | Blocking | Without it |
|---|---|---|---|
env:read | every direction | yes | Preview cannot list the deployment's variables. |
env:write | export | yes | Export cannot write anything. |