Docs
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

WhatThis provider
VendorConvex
Keyconvex-deployment-env
Availabilityavailable. You can connect it today.
Credential penv holdsconvex-token
Values read backyes
Activationimmediate

What it moves

DirectionWhat it does
importReads names and values out of the store into penv.
exportWrites 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

DirectionPolicies you can pick
importskip_existing, new_version, fail
exportcreate_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.

FieldLabelKindRequiredWhat it is
tokenTokensecret, masked here and sealedyesA deployment key or team access token.

What the connection asks for

Fixed when you connect, and shared by every mapping on it.

FieldLabelKindRequiredAdvancedWhat it is
deploymentNameDeploymenttextyesnoThe 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.

PermissionDirectionsBlockingWithout it
env:readevery directionyesPreview cannot list the deployment's variables.
env:writeexportyesExport cannot write anything.