Request model
Quickly set up the payload fields of your action in your NLX workspace
Last updated
Quickly set up the payload fields of your action in your NLX workspace
Last updated
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
To access this feature, click the Request model tab of your action:
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 Action node
List: A list of values that can have other response types nested within
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
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
