Reference
Convex
Sync an environment with a Convex deployment's environment variables.
Sync an environment with a Convex deployment's environment variables.
Connection
| What | This provider |
|---|---|
| Vendor | Convex |
| Key | convex-deployment-env |
| Availability | available. You can connect it today. |
| Credential we hold | convex-token |
| Values read back | yes |
| Activation | immediate |
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
immediate. The running app sees a new value at once.
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 | Token | secret; we mask it here and seal it | yes | A deployment key or team access token. |
Connection fields
You set these when you connect. Every mapping on the connection shares them.
| 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. |
Required permissions
We probe for these when we verify 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. |