GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Help & Learning Resources
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Nodes & Connections
Overview
Node Types
Intent Node
Dialog Node
Entity Node
Entity Rules
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections Setup
Context Object
Sub-Intent Scoping
User Prompts
Voice Call Properties
Dialog Task Management
Event Handlers
Supported Entity Types
Supported Company Names
Supported Colors
Knowledge Graph
Introduction
Knowledge Extraction
Build Knowledge Graph
Create Node Structure
Build the Graph
Add FAQs
Add FAQs from an Existing Source
Run a Task
Traits, Synonyms, and Stop Words
Manage Variable Namespaces
Update Knowledge Graph
Introduction
Move Question and Answers Between Nodes
Edit and Delete Terms
Edit Questions and Responses
Knowledge Graph Analysis
Knowledge Graph Import and Export
Prepare Data for Import
From a CSV File
From a JSON File
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
Intelligence
Introduction
Default Standard Responses
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Health and Monitoring
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
NLP Insights
Conversations History
Conversation Flows
Analytics Dashboard Filters
Usage Metrics
Containment Metrics
Smart Bots
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Plan & Usage
Overview
Usage Plans
Support Plans
Invoices
Authorization
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data as Service
Data Table
Table Views
App Definitions
Sharing Data Tables or Views
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Configure Agent Transfer
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Composite Entities
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Intent Scoping using Group Node
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters
APIs & SDKs
API Reference
API Introduction
API List
API Collection
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Using the BotKit SDK
BotKit SDK Tutorial - Blue Prism
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Builder
  5. Dialog Task
  6. WebHook Node

WebHook Node

You can use the WebHook node to subscribe to a message and to WebHook events that 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 Virtual Assistant. For more information, refer to SDK Configuration. Let us use the example of an Agent Transfer app.

  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.


Add the Node

Webhook Nodes can only be added as part of a Bot Action node. Therefore, before you can add a Webhook Node, you need to add a Bot Action node.

Note: Post v9.0 of the Platform, the Webhook node is categorized under the Bot Action node. For details on the Bot Action node.

 

Keeping this in mind, the setup a Webhook node in a dialog task involves the following steps:

  1. Open the dialog task to add the Webhook node.
  2. Create and/or expand a Bot Action node.
  3. Add a Webhook node in the designated place. For steps related to adding nodes, refer here.
  4. The Webhook window is displayed with the Component Properties tab selected by default.
  5. To connect a Webhook node to a node outside of its containing Bot Action node, please read our article about the Bot Action Node.


Configure the Node

Component Properties

Notes:

  1. All changes made to the Component Properties tab will affect all instances of the Webhook Node, across Dialog Tasks.
  2. If you have not yet configured the SDK, the Component Properties section will notify you that the SDK is not currently configured/Subscribed. Please go to API Extensions to configure the SDK.

 

To configure the Component Properties tab, please follow the steps below:

  1. On the Component Properties tab, under the General Settings section, enter the Name and Display Name of your Webhook node. 
  2. In the Variable Namespaces section, associate the variable namespaces to execute this node and its transitions. This option is visible only when the Variable Namespace is enabled for the VA. You can go with the task level settings or customize it for this node. For more information, refer to Managing Namespace.


Instance Properties

Use the Instance Properties to define any user tags that you want to set for the Webhook node.

Note: The settings in the Instance Properties tab are specific to the current dialog task and do not reflect in other dialog tasks that use this node.

     

  1. On the Webhook node properties panel, click the Instance Properties tab.
  2. Under the Custom Tags section, add tags to build custom profiles of your VA’s conversations. Click here for more.


Connections Properties

Since they are contained within Bot Action nodes, Webhook nodes cannot be connected on their own to any other nodes outside the Bot Action node to which they belong. Connections can only be made with nodes contained within the same Bot Action node. 

From the node’s Connection Properties tab, you can configure the following:

  • Webhook Node Connections: The node within the Bot Action to execute next, after the Webhook node runs. 
  • Bot Action Connections, where you can update the node to trigger after the Bot Action group is executed. Updates made here will apply to all nodes within the same Bot Action. 

For both connection types you can write conditional statements based on the values of any Entity or Context Objects in the dialog task, or you can use Intents for transitions. 

Note: The conditions configured here are applicable only for this instance and will not affect this node when being used in any other dialog.

 

To set up node connection conditions, please follow the steps outlined in Adding IF-Else Conditions to Node Connections

Menu