Managing Secrets
In this guide, you'll learn how to manage secrets in your FastStore project using WebOps.
Secrets are sensitive information, such as API keys, passwords, and tokens, that must be securely managed during the FastStore project deployment.
WebOps centralizes and standardizes secrets management, ensuring a consistent and secure process across all deployment providers. This ensures that sensitive information is kept out of your project’s codebase and is retrieved securely by WebOps.
For stores not using WebOps, secrets is handled through the VTEX IO CLI secrets plugin. To enable secrets management, an emptyvtex.env
file need to be present in the project root. The key-value pairs is stored in thesecrets.revealed.json
file, then encrypted intosecrets.hidden.json
before being committed to the main branch. For stores using WebOps, this workflow has been deprecated, and secrets are managed directly through the WebOps interface.
Local development
For local development, you must use the
vtex.env
file to define secrets needed to run your FastStore project locally.The
vtex.env
file is only used in local environments and should always be added to .gitignore
to avoid leaking secrets through version control. By adding it to .gitignore
, secrets defined in the vtex.env
file will not be available in deployed environments via WebOps.Instructions
To manage your secrets, access your FastStore WebOps dashboard and navigate to the Settings tab.

Creating secrets
-
In the
Key
field, enter the name of the secret, which serves as its unique identifier (example: VTEX_API_TOKEN, NEXT_SECRET_KEY). In theValue
field, enter the corresponding sensitive information you want to store (example: the actual token, key, or password).Secrets accessible in the browser (client-side) must start with the prefixNEXT_PUBLIC_
. For all other secrets, use other names without this prefix. -
Click
Add
. A pop-up withNew Secret added successfully
will open. Then, you'll see the messageSecrets have changed. Changes will take effect in the next successful deployment.
alongside aRedeploy
button.When creating multiple secrets, make sure you include all of them before proceeding to the next step. This prevents synchronization errors. -
Click
Redeploy
to redeploy your website with the updated secret configuration. You’ll see the messageRedeploying with secret changes
, then a pop-up withDeployment created successfully
will open. -
Follow the deployment status in the Deploys tab of the WebOps dashboard.During the build process, any secrets registered through WebOps will be transformed into environment variables within the code, automatically loading them into the
process.env
object. You can access these values in your code usingprocess.env.VARIABLE_NAME
. Remember to replaceVARIABLE_NAME
with the name you assigned to your secret in theKey
field.The secret created will be available in the Current Keys section.

Updating secrets
- Go to the
Current Keys
section. - Alongside the secret you need to update, click
⋮
, then clickEdit
. - Click
Update
. A pop-up withSecret updated successfully
will open. Then, you'll see the messageSecrets have changed. Changes will take effect in the next successful deployment.
alongside aRedeploy
button. - Click
Redeploy
to redeploy your website with the updated secret configuration. You’ll see the messageRedeploying with secret changes
, then a pop-up withDeployment created successfully
will open. - Follow the deployment status in the Deploys tab of the WebOps dashboard.

Deleting secrets
-
Go to the
Current Keys
section. -
Alongside the secret you need to update, click
⋮
, then clickDelete
. -
Validate the secret you want to remove.This action can’t be undone.
-
Click
Delete secret
. A pop-up withSecret deleted successfully
will open. Then, you'll see the messageSecrets have changed. Changes will take effect in the next successful deployment.
alongside aRedeploy
button. -
Click
Redeploy
to redeploy your website with the updated secret configuration. You’ll see the messageRedeploying with secret changes
, then a pop-up withDeployment created successfully
will open. -
Follow the deployment status in the Deploys tab of the WebOps dashboard.

If you tried to create, update, or delete a secret and received the errorFailed to create/update/delete secret. Please, try again.
, repeat the process. If the problem persists, open a ticket to VTEX support.