LogoLogo
  • GETTING STARTED
    • Welcome to the NLX platform
    • How NLX works
    • Guides
      • Analytics dashboard
      • Chat
      • Generative Journey (Slots)
      • Model Context Protocol
      • Voice
      • Voice+
      • 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
  • Test & Deploy
    • 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's the Request model of an Action?
  • Data property types
  • Auto-generate request schema
  • Manually enter request schema
  1. Build
  2. Resources
  3. Actions

Request model

Quickly set up the payload fields of your action in your NLX workspace

Last updated 5 days ago

This feature is currently available to enterprise tiers only.

What's the Request model of an Action?

An Action's Request model tab allows you to specify and shape the payload data to be sent with your API call.

When building your conversations, you can also populate these fields dynamically to achieve some custom behavior. For instance, if you collected a name during a conversation, you can transmit this name to your webhook, so it can be included inside a welcome email.

Need more context? See the side panel setup of an


Data property types

  • String: A simple text value, such as a customer's name

  • Number: An integer, such as a customer's age

  • Boolean: A value consisting of true or false

  • List: A list of values that can have other response types nested within


Auto-generate request schema

The simplest method for inputting your request schema is to use the model generation tool:

  • Enter/paste sample JSON request

  • Click Set request schema

  • Click Save


Manually enter request schema

When selecting Object or List request schemas, a sub-items section will display to specify the multiple values:

  • Expand Items/Properties section > Click +Add property

  • Expand new property section > Enter Field name

  • Choose the specific value's schema type using the dropdown

  • Repeat steps to add properties, as needed

  • Click Save

Optional:

  • Sensitive: Enable if you would like the values to be scrubbed from any resulting conversation logs

  • Description: Provide a statement describing the request model or intended function of the setup

Object: A well-defined structure of multiple values, such as name, age, occupation. Use if wanting to reference the values in the payload of the

Select Auto-generate

✨
🧠
Action node
Action node
Request model tab of an Action