Circuit Secrets

Circuit secrets allow you to store sensitive key/value pairs—like API tokens, encryption keys, or database credentials—in a secure, encrypted store. These values can then be referenced within your circuit’s definition and steps without ever exposing the raw secret.

Where to Find Secrets

• Navigate to the Settings tab of your circuit.
• Select Secrets from the side menu.

This page displays a list of all secrets associated with your circuit. Each entry shows:

• Name: The key used to reference the secret in your circuit (e.g. API_KEY).
• Value: The secret value is not displayed in the UI.

Adding a New Secret

1. Click Add Secret (or similar button) in the Secrets view.
2. Enter a Name (alphanumeric, underscores) and the Secret Value.
3. Save. Secrets are encrypted at rest and never stored in plain text in the UI or logs.

Using Secrets in Your Circuit

1. In your circuit definition, reference a secret using the ${{ secrets.YOUR_SECRET_NAME }} syntax in any input, header, or body field.
2. At execution time, the system injects the decrypted value into your runtime environment.

Example:

"headers": {
  "Authorization": "Bearer ${{ secrets.API_KEY }}"
}

Managing Existing Secrets

• Edit: Click the inline buttons next to a secret to view or update its value.
• Delete: Remove a secret when it’s no longer needed; this will revoke its availability in subsequent runs.

Security: All secrets are encrypted with industry‑standard AES‑256 in transit and at rest. Access to view or modify secrets is restricted by circuit permissions—only authors and collaborators with write access can manage them.

Best Practices

• Rotate keys regularly by creating a new secret and updating your circuit references.
• Limit the number of secrets in a circuit to only those required for external integrations.
• Leverage environment‑specific circuits or versioning to avoid embedding production secrets in development circuits.

Ensure your secrets remain confidential and only accessible to authorized circuit collaborators.