Secrets
Manage and set up sensitive parameters for added security and efficiency in an NLX workspace
Only Administrator, Developer, or custom roles with specified permissions may set up Secrets in a workspace.
What are Secrets?
Secrets allow for the secure management and configuration of environment variables when referencing them during setup of a Data request, Action, or Lifecycle hook or in a flow through a Data request node.
They may be used to provide workspace efficiency when needing dynamic placeholders for commonly typed values, such as URL strings as well as static or dynamic values, including API keys, tokens, or passwords.
To access, click Resources in your workspace menu and choose Secrets:
Add a secret
Begin by selecting + Add secret from the Secrets resource:
Enter a name and the secret's value
Add an optional description
Keep Sensitive setting enabled (default) or disable. The sensitive setting turns the Secret's value to asterisks and redacts it from conversation logs
Click Create secret
Need to edit or delete a Secret? After creating your Secret, you may expand its details and select Edit or Delete secret at any time.
Use a Secret
Once a Secret has been created, you may reference it easily when managing Data requests, Actions, Lifecycle hooks, or directly in payload fields of a Data request node:
When setting up a custom webhook:
Create new or select an existing Data request, Action, or Lifecycle hook
Under the resource's external tab of Implementation, reference your secret in the URL field or in the value field under Headers
When referencing in a flow:
After creating a Data request with a Request model defined, create or selecting an existing flow in the workspace
Add a Data request node to the Canvas > Select + Add data request on the node
Enable the Custom toggle and choose the Data request you created
Enter an open curly brace
{on the payload field that should receive the secret and select the secret created
Last updated