Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots's Approach Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Platform
How to Access Bot Builder
Working with Bot Builder
Building your first Bot
Getting Started with Building Bots
Using the Dialog Builder Tool
Creating a Simple Bot
Release Notes
Latest Updates
Older Releases
Bot Builder
Creating a Bot
Dialog Task
Working with User Intent Node
Working with the Dialog Node
Working with Entity Node
Supported Entity Types
Working with Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Working with Message Nodes
Working with the Confirmation Nodes
Working with Service Node
Implementing Custom Authentication
Enabling 2-way SSL for Service nodes
Working with Script Node
Working with Agent Transfer Node
Working with WebHook Node
Defining Connections & Transitions
Managing Dialogs
Prompt Editor
Action & Information Task
Working with Action Tasks
Working with Information Tasks
Establishing Flows
Alert Tasks
Working with Alert Tasks
Managing Ignore Words and Field Memory
Knowledge Graph
Building Knowledge Graph
Generation of Knowledge Graph
Importing and Exporting Knowledge Graph
Knowledge Graph Analysis
Knowledge Extraction
Natural Language
Machine Learning
ML Model
Fundamental Meaning
Knowledge Graph Training
Ranking and Resolver
NLP Detection
NLP Settings and Guidelines
Bot Intelligence
Context Management
Session and Context Variables
Context Object
Dialog Management
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Default Conversations
Default Standard Responses
Channel Enablement
Test & Debug
Talking to Bot
Utterance Testing
Batch Testing
Recording Conversations
Publishing your Bot
Analyzing your Bot
Custom Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Universal Bots
Enabling Languages
Smart Bots
Sample Bots
Travel Planning
Flight Search
Event Based Bot Actions
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Bot Management
Using Bot Variables
API Guide
API Overview
API List
API Collection
SDK Overview
SDK Security
SDK App Registration Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Web Socket Connect & RTM
Using the BotKit SDK
Installing the BotKit SDK
BotKit SDK Configuration
Events for the BotKit SDK
Functions for the BotKit SDK
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
Bot Administration
Bots Admin Console
User Management
Managing Users
Managing Groups
Managing Role
Bots Management
Inviting Users
Sending Bulk Invites to Enroll Users
Importing Users and User Data
Synchronizing Users from Active Directory
Security & Compliance
Using Single Sign-On
Cloud Connector
How Tos
Context Switching
Using Traits
Live Agent Transfer
Schedule a Smart Alert
Configure Agent Transfer
Custom Dashboard
Patterns for Intents & Entities
Build Knowledge Graph
  1. Home
  2. Docs
  3. Bots
  4. Bot Building
  5. Dialog Task
  6. Working with the WebHook Node

Working with the 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 SDK Tool BotKit to add event handlers and control the messages and WebHook events as required by connecting the WebHook node to a Script node to process the response.

Before you Begin: Creating and Registering an App

To get access to WebHook events and use WebHook nodes in your Dialog task, you need to subscribe and configure an app on the Settings tab for your Bot. For more information, see SDK Configuration.

  1. Hover over the side navigation panel and click Apps & Agents.
  2. On the Apps & Agents window, click the Agent Transfer tab.
  3. From the App Name drop-down list, select an existing app or click Create App.
  4. In the Create Client App dialog, enter a Name for the app, and then click Next.
  5. The Client Id and Client Secret appear. Click Done.
  6. In the Callback URL field, enter the URL from your live agent application.
    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.
  7. Click Save. The Successfully subscribed message is displayed.

Setting up the WebHook Node

Setting up a WebHook node in a Dialog task involves the following steps:

Step 1: Adding a WebHook Node to the Dialog Task

  1. Open the dialog task in which you want to add the WebHook node.
  2. Hover over a node next to which you want to add the WebHook node, and click the plus icon on it.
  3. Click the Plus icon that appears after the node, and then select Intent > New WebHook node. The Component Properties pane for the entity opens.
  4. Enter a name for the node.
  5. The other settings are auto-filled based on your Agent Transfer SDK configuration. Got to Apps & Agents for changing any settings.
  6. Timeouts can be configured by selecting from the range of 1 to 10 minutes. By default, it is set to 4 minutes.

Step 2: Configuring the Connections (or Transitions) Properties

You can add If-Else operators in the node’s Connections pane 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 setup Component Transitions, follow these steps:

  1. Hover over the node, and click the icon. The Connections pane opens.
  2. On the Connections pane, click Add IF.
  3. 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. 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. Example: Context.entity.PassengerCount (Context object) greater than (operator) 5 (specified value)
    • Intent: Select an intent that should match the next user utterance.
  4. 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).
  5. In the Else drop-down list, select the node to execute if the condition fails.
Note: If you want to write multiple If conditions, click Add Else If below the last If conditional expression.