Chat Flow - External Link Handler API
Why use this API?
The External Link Handler API lets you direct an end-user to an external web page from within a Chat Flow conversation and return to the Chat Flow conversation with optional additional data gathered from the external web page.
When to use this API
This API is used with the External Link node in Chat Flow to call an external web URL and enable the URL to return a single variable result to your workflow.
Typical use cases include:
Directing end-users to a website to read terms and conditions or to complete a survey.
Creating an out-of-band authentication module using a web URL.
Handing over end-user communication to another channel triggered via a web URL (e.g., a web-based chat or VOIP call into an IVR).
Getting started with the External Link Handler API
Build a workflow in Chat Flow containing an External Link node.
Add the /callback endpoint into the website back-end script. This endpoint handles the return call from an external service, takes in a response and any additional information, and then continues the conversation with the end-user.
Ensure that what your system passes back as the result matches what you have constructed in Chat Flow, especially the results specified in the "Logic" section of the External Link node.
JavaScript is not supported for this callback endpoint.
