Actions: Request model

Quickly set up the payload fields of your action in NLX's Dialog Studio

What's the Request model tab?

The Request model tab allows you to specify the payload fields for your action when you use it in any intent flow. When called, your action will receive a pre-defined set of payload fields. 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 Action node


Access

To access this feature, click the Request model tab of your action:


Request model type

Choose the request type for the model from the available dropdown:

  • 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

  • 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 Data request node

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


Request properties

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

Save time by using the Auto-generate option.

Optional Settings

  • 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


Auto-generate schema

One simple way of generating your request model is to use the model generation tool based on a sample JSON request body:

  • Select <> Create from example JSON

  • Enter/paste sample JSON request

  • Click Set request schema

  • Click Save

Last updated