Request model
Define the information relayed from data requests in your NLX workspace
What's the Request model of a Data request?
A Data request's Request model 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.
Request model setup is only applicable when your Data request is set up with an External implementation.
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
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
Auto-generate response schema
The simplest method for inputting your request schema is to use the model generation tool:
Select ✨ Auto-generate
Enter/paste sample JSON response
Click Set request model
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, or for providing context to an LLM when assigning the Data request as a tool in agentic mode
Last updated