Creating and Managing Secrets

The Secrets tab in Livedocs is designed for securely managing sensitive information required in your documents. This includes API keys, database passwords, and other confidential data that your workflows may depend on. By using the Secrets tab, you can organize and store credentials securely while keeping them easily accessible for use in your documents.

Adding a New Secret

Secrets in Livedocs are stored as name-value pairs. Each secret must have a unique name for identification, making it easy to reference within your documents.

To add a secret:

1. Navigate to the Secrets tab in the Livedocs workspace.
2. In the Name field, enter a unique identifier for your secret (e.g., MY_API_KEY or DATABASE_PASSWORD).
3. In the Value field, provide the sensitive information you want to store.
4. To add multiple secrets at once, click the Add another button to create additional input fields.
5. Click Save secrets to save all the entered secrets.

tip

For better consistency and readability, use uppercase letters with underscores when naming secrets (e.g., MY_API_KEY). This convention helps in recognizing and managing sensitive information across platforms.

Viewing and Deleting Secrets

Once added, secrets appear in a list under the Secrets tab. The secret values are hidden by default for security purposes. You can reveal or hide each secret's value by clicking the eye icon next to its name.

To delete a secret:

1. Locate the secret in the list view.
2. Click its corresponding menu (three vertical dots).
3. Select Delete from the menu list.

caution

Deleting a secret will affect any documents that rely on it. Ensure you verify its usage in your documents before proceeding with deletion.

Managing Secrets in the Sidekick

In addition to the Secrets tab, you can manage secrets directly within the Sidekick, a toggleable sidebar in the document workspace. The Variables section of the Sidekick provides a streamlined interface for adding and accessing secrets dynamically as you work.

Adding Secrets in the Sidekick

1. Open the Sidekick in your document.
2. Navigate to the Variables section.
3. In the Secrets area, click + Add secret.
4. Enter a value in the Name and Value input fields for your secret.
5. Click Add secret to store your new secret.

Secrets added via the Sidekick are immediately accessible within the document, making it convenient to add secrets without leaving the document workspace.

Viewing and Using Secrets in the Sidekick

The Variables section displays all secrets available to the user, with their values hidden by default for security. For each secret, you can do the following:

• Reveal or hide its value by clicking the eye icon next to it.
• Delete the secret by clicking the menu (three vertical dots) and then Delete.

Managing Secrets Securely

The Secrets tab and the Sidekick together provide a centralized and dynamic way to manage sensitive information. By leveraging these tools, you can streamline your workflows and maintain the highest level of security for your credentials.

In the next guide, we will explore how to use these secrets in your queries and code to securely integrate with external resources.