Data requests: Edit page
Review and edit a data request implementation in your NLX Dialog Studio workspace
Access a data request
To access a particular data request, open Data requests from your workspace menu and select the one you'd like to view:
Duplicate, Save, & Test
In the top right of your data request's page, you'll find the Duplicate, Save, and Test options.
Duplicate: For cloning the data request, including its implementation and model setup. This is also an alternative approach if renaming your data request is necessary
Save: For committing all changes made while on the data request's edit page
Test: For testing the response model and/or the request model of your data request
Testing your data request
Quickly confirm your data request is set up and configured properly by using the Test feature:
Sample setup:
The sample endpoint should receive a POST request with a body that sends the variableId and payload attribute. The response returns the resolvedVariables attribute with variableId variable and value object that can be mapped
Select Response model tab > Select the type of object returned. In this example, the value attribute returns an Object with attributes firstName, lastName, and id
Select Request model tab > Add the payload field. In this example, the payload field is email
Click the Implementation tab and switch to External mode > Add the URL for the endpoint in the URL field
Add the necessary headers, if applicable. Some webhook endpoints need an API key. For this example, none is needed
Click Save
Click Run Test to test the endpoint
The response should look identical to your expected response, indicating a successful setup.
Description & Tags
If set up, a short description and any tags given to the data request display under the data request name. You may add or modify these in the data request's Settings.
Tabs
There are several tabs available to configure your data request:
Data requests: ImplementationData requests: Response modelData requests: Request modelData requests: UsageData requests: VersionsData requests: SettingsLast updated