Data requests: Request model

Define the information relayed from data requests in your intent flows using NLX's Dialog Studio

What's the Request model tab?

Request model allows you to specify and shape data to be sent back to your API/webhook (e.g., create a new user profile).

Request model setup is only applicable when your data request is set up with an External implementation.


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

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