Skip to main content

Secrets

Secrets or secret values such as API keys, database passwords, and access tokens, enable workflows to interact with external services, databases, and other resources securely. The Secrets and Credentials page is where these values are stored and managed for use across your workflows.

img

Creating a new secret value

To create a new secret value, go to the Secrets and Credentials page and click "Add new" and then select Secret value from the dropdown.

img

Set a display name and description for the secret value, and then set the placeholder value. This will be the placeholder used to reference and invoke the secret within a component and workflow.

img

Note that all secrets have a suffix ".SECRET" set at the end to help identify them from other placeholders.

tip

When secrets or credentials are associated with a workflow, they name and description is provided to the AI to allow it to understand what external integrations or apps it can use. The AI derives its understanding of the secret/credential from the name and description, so it helps to make the name and description as detailed and accurate as possible. The actual secret value is never disclosed to the AI.

Finally, you can set the value of the secret. Note that once the secret has been created, this value will be securely stored and cannot be retrieved or viewed again.

img

Click save to create the secret.

Setting permissions for a secret value

You can set where the secret can be used via the permissions settings.

important

If a secret is used in a component or workflow where it does not have the appropriate permission, it will be printed as an empty or blank value i.e. if the component or workflow does not ahve permission to use a secret, the secret will not be substituted in when the component or workflow is run.

Can be used in any component and workflow

In this setting, the secret can be access from any compatible component and any workflow in your account

Can only be used in selected workflows

In this setting, the secret can be used in any component in the selected workflows.

Can be only be used in selected components

In this setting, the secret can only be used in specific components in a specific workflow.

Updating a secret value

To update a secret, click on the secret and make the required changes. You can update or change the name, description and placeholder label. Note that you cannot view the value of the secret after it has been created, but you can replace it or overwrite it with another value.

warning

Be careful with changing secret placeholder labels or values - this can break any components currently referencing the or relying upon the current secret value.

Deleting a secret

To delete a secret, click the Delete button. You will then be prompted to confirm this action.

danger

This action cannot be undone - once a secret is deleted, it will be permanently deleted and cannot be recovered.