You can use the WebHook node to subscribe to a message and WebHook events to capture real-time data from real-time events and show them to the user. You can use the WebHook node for server-side validation, execute business logic, or make backend server API calls. Also, you can use the Kore.ai SDK Tool BotKit to add event handlers, control the messages and WebHook events as required by connecting the WebHook node to a script node to process the response.
Create and Register an App
To get access to WebHook events and use WebHook nodes in your dialog task, you need to subscribe and configure an app in the Settings tab of your Bot. For more information, refer to SDK Configuration.
- On the left pane, click API Extensions. By default, the BotKit SDK tab is displayed.
- Click Agent Transfer.
- On the Agent Transfer page, click Add next to the App Name drop-down list.
- On the Create Client App window, enter the app name in the Name field. For example, SDK App.
- Click Next.
- The Client ID and Client Secret are generated along with the App Created Successfully message.
- Click Done.
- In the Callback URL field, enter the URL for your application that you want Kore.ai to push data to. For example, https://koremessenger.com/postURL.
Note: The registration app you create is based on the Callback URL applicable to all tasks for the bot. While each task can have unique SDK configurations, the Callback URL is the same. Create separate bots for separate application Callback URLs for live agent transfers.
- Under the PII Data section, define how sensitive information should be handled. If there is a need to share unmasked data when an agent session is in progress, even when PII redaction is enabled, select the Do not mask and send original data to Agent BotKit. Else, go with the default setting of Mask and send sensitive data to Agent BotKit.
- Under the Access Using a Connector section, indicate if your URL is behind a firewall and a Connector has to be used.
- Click Save. The Successfully subscribed message is displayed.
Set Up the WebHook Node
Setting up a WebHook node in a dialog task involves the following steps:
Add a WebHook Node to the Dialog Task
- Open the dialog task to add the WebHook node.
- Click the + icon next to the respective node.
- Select Intent > New WebHook Node.
- On the WebHook window, by default, the Component Properties tab is displayed.
- Enter a Name and Display Name for the node.
- The other settings are auto-filled based on your Agent Transfer SDK configuration. Go to API Extensions to modify any settings.
- In the Variable Namespaces section (introduced in v8.0), associate the Variable Namespaces to execute this node and its transitions. This option is visible only when the Variable Namespace is enabled for the bot. You can go with the task level settings or customize it for this node. For more information, refer to Managing Namespace.
Configure the Connections Properties
You can add If-Else operators in the node’s Connections tab to determine which node in the dialog text to execute next. You can write the conditional statements based on the values of any Entity or Context Objects in the dialog task, or you can use intents for transitions.
To set up Component Transitions, follow the below steps:
- Click the Connections tab.
- On the Connections tab, under the Connection Rules section, click Add IF.
- Configure the conditional expression based on one of the following criteria:
- Entity: Compare an Entity node in the dialog with a specific value using one of these operators: Exists, equals to, greater than equals to, less than equals to, not equal to, greater than, and less than. Select the entity, operator using the respective drop-down lists, and type the number in the Value box. For example, PassengerCount (entity) greater than (operator) 5 (specified value)
- Context: Compare a context object in the dialog with a specific value using one of these operators: Exists, equals to, greater than equals to, less than equals to, not equal to, greater than, and less than. For example, Context.entity.PassengerCount (Context object) greater than (operator) 5 (specified value)
- Intent: Select an intent that matches the next user utterance.
- In the Then go to drop-down list, select the next node to execute in the dialog flow if the conditional expression succeeds. For example, if the PassengerCount (entity) greater than (operator) 5 (specified value), Then go to Offers (sub-dialog).
- In the Else drop-down list, select the node to execute if the condition fails.
- Click Save.