WebHook Node

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 Deploy -> Integrations tab of your Bot. For more information, refer to SDK Configuration.

1. Select the Deploy tab from the top menu
2. On the left menu, click Integrations -> Agent Transfer.
3. On the Agent Transfer page, click Add next to the App Name drop-down list.
4. On the Create Client App window, enter the app name in the Name field. For example, SDK App.
5. Click Next.
6. The Client ID and Client Secret are generated along with the App Created Successfully message.
7. Click Done.
8. 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.
9. 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.
10. Under the Access Using a Connector section, indicate if your URL is behind a firewall and a Connector has to be used.
11. Click Save. The Successfully subscribed message is displayed.

Set-Up

Setting up a Webhook node in a dialog task involves the following steps:

Note: Post v9.0 of the platform, the Service node is categorized under the Bot Action node. For details on the Bot Action node, click here.

Add Node

1. Open the dialog task to add the Webhook node.
2. Add Webhook node in the designated place. For steps in adding nodes, refer here.
3. The Webhook window is displayed with the Component Properties tab selected by default.
4. You can configure the Connection Properties, refer here for details.