LogoLogo
  • GETTING STARTED
    • Welcome to the NLX platform
    • How NLX works
    • Guides
      • Analytics dashboard
      • Chat
      • Generative Journey (Slots)
      • Model Context Protocol
      • Voice
      • Voice+ script
      • Touchpoint components
        • Carousel modality
        • Video modality
    • Terms & concepts
    • Generative AI
    • Developer
  • Build
    • Workspace setup
    • Flows
      • Intro to flows & variables
      • The Canvas
      • Flow settings
      • Nodes
      • Flow appearance
    • Resources
      • Actions
        • Implementation
        • Request model
      • Analytics tags
      • Context variables
      • Data requests
        • Implementation
        • Response model
        • Request model
      • Knowledge bases
        • Ingest content
        • Add metadata (beta)
        • Apply KB
      • Lifecycle hooks
        • Implementation
      • Modalities
      • Secrets
      • Slots (custom)
        • Adding values
        • Translating slots
      • Voice+ scripts
        • Add + download script
        • Deploy script + install SDK
        • Create Voice+ flow
    • Integrations
      • Channels
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Bandwidth
        • Genesys
        • Twilio
        • Zendesk Sunshine
      • LLM services
        • Amazon Bedrock
        • Anthropic
        • Azure OpenAI
        • Cerebras
        • Cohere
        • Google Vertex AI
        • Groq
        • NVIDIA
        • OpenAI
        • xAI
      • NLP
        • Amazon Lex
        • Google Dialogflow
        • Google Dialogflow CX
        • Custom NLP
    • Translations
  • Deploy & test
    • Applications
      • Attach flows
      • Assign default behavior
      • Add channels
        • API
          • REST API
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Genesys
        • Genesys SMS
        • Messenger
        • Microsoft Teams
        • Slack
        • SMS via Bandwidth
        • Twilio SMS
        • Twilio Voice
        • WhatsApp via Twilio
        • Zendesk Sunshine
      • Deploy
      • Optional: Set lifecycle
      • Optional: Set languages
    • Test
      • Test a conversation
      • Automated tests
      • Test an external integration
  • Analyze
    • Conversations
    • Analytics
      • Creating dashboards
      • Formulas & multi-metrics
      • Canvas analytics
    • Training
  • Workspace Settings
    • Escalation channels
    • Resource tags
    • Audit
  • Admin
    • Access control
      • Roles & permissions
    • Notifications
    • FAQ
    • Contact support
Powered by GitBook
On this page
  • What are Secrets?
  • Add a secret
  • Use a Secret
  1. Build
  2. Resources

Secrets

Manage and set up sensitive parameters for added security and efficiency in an NLX workspace

Last updated 1 month ago

Only , or 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 , , or or in a flow through a .

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

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

Select from available Secrets by entering an open curly brace { in the text field.

Once a Secret has been created, you may reference it easily when managing , , , or directly in payload fields of a :

Administrator, Developer
Data request
Action
Lifecycle hook
Data requests
Actions
Lifecycle hooks
Data request node
Data request node
custom roles