Data requests: Implementation

Set up a static or external response for your data request in NLX's Dialog Studio

What's the Implementation tab?

Implementation is where you'll set up a static response or external webhook/API for your data request. When a user arrives at a Data request node in an intent flow, it triggers the static response or HTTP method for engaging your data to be brought into the conversation.

Once invoked using a Data request node in your intent flow, information from your data request can then be relayed in messaging or used in conditional logic in subsequent nodes of the flow.


Access

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


External implementation

External mode is used when data is hosted externally and when a specific API/webhook can be reached through a URL:

  • Set the implementation toggle to External

  • Select the appropriate HTTP method from the Method dropdown

  • Expand endpoint section > enter the URL

  • Use NLX's AWS CloudFormation template provided within the Instructions section

  • Click Save

Whether you have sensitive data or frequently enter the same URL string, try setting up a parameter in your workspace for enhanced security and efficiency.

Optional setup

  • Headers: expand section> click + Add header > enter the Name and static Value to be sent with the request. Useful for custom headers such as an API key, content type, content length, etc.

  • Dynamic: Enabling the toggle allows you to view the header and provide it a custom value on the Data request node's side panel when referencing the data request in an intent flow

  • Development endpoint: for situations where multiple URLs are used by the environment

Now that your implementation setup is complete, you may move on to configuring your request and/or response models.


Static response

Static mode is used in cases where the data response is unchanging, which may be particularly useful for building demos or for early testing. Switch the implementation's toggle to Static to begin:

  • Enter the data array in JSON structure

  • Click Save

Now that your implementation setup is complete, you may move on to configuring your request and/or response models.

Last updated