Implementation
Easily set up your lifecycle hook's external webhook in NLX's Dialog Studio
What's the Implementation tab?
Implementation is where you'll set up a static response or external webhook/API URL for your lifecycle hook. When a conversation with a bot starts, ends, escalates, or streams state modifications and a lifecycle hook is attached at one of those stages, the webhook will trigger the specified URL and run the process required.
Need more context? See Bot lifecycle & settings
Access
To access this feature, click the Implementation tab of your lifecycle hook:
External implementation
External mode is used for integrating with a URL that triggers your lifecycle hook:
Set implementation toggle to External
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 Value to be sent with the request. Useful for custom headers such as an API key, content type, content length, etc.
Now that your implementation setup is complete, attach your lifecycle hook to a bot under the bot's Lifecycle tab.
Static response
Static mode is useful for creating a static response when building demos or for early testing.
Set implementation toggle to Static
Enter your response in JSON structure
Click Save
Now that your implementation setup is complete, attach your lifecycle hook to a bot under the bot's Lifecycle tab.
API spec
HTTP POST payloads that are delivered to your lifecycle hook's configured URL endpoint will contain a few headers, including:
The body of the POST request your webhook will receive may contain:
The response body of your lifecycle hook can optionally include the following properties:
For example, the response body of a lifecycle hook for a conversationStart
event type may look like this:
Last updated