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 Tasks
Knowledge Ontology
Building Knowledge Graph
Importing and Exporting Bot Ontology
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
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
Bot Store
Creating a Bot Account
Adding a Bot
Choosing a Channel for a Bot
Interacting with a Bot
Setting Up Web Service Alerts
Setting Up RSS Alerts
Setting Up the Webhook Bot
Custom Bots
Bots for your Customers FAQs
Bots for your Workforce FAQs
Adding Bots
Contacting Support
Setting Up Filters
Bot Store Settings
How Tos
Context Switching
Using Traits
Live Agent Transfer
Schedule a Smart Alert
Configure Agent Transfer
  1. Home
  2. Docs
  3. Bots
  4. Bot Store
  5. Setting Up the Webhook Bot

Setting Up the Webhook Bot provides many built-in Bots that you can use to show alert messages in a account, execute Bot tasks, and create a related task for an alert. Each alert can be defined with filters to display only the relevant data needed by the end-user.

This topic describes the generic steps using the Webhook Bot. For more information about other Bots, see Adding Bots.

The Webhook Bot is a generic webhook that you can use to configure webhooks for a website, system, or web application, not currently offered as a built-in Bot.

Configuring Webhooks

To configure the Webhook Bot, you must have an account with administrator access as well as API access to configure a webhook, in the corresponding website, system, or web application. If you don’t, you’ll need to contact the system administrator.

To get started configuring the webhook for your Bot, you’ll need two things:

  1. The webhook URL provided when you set up an alert in your account for each alert that you want to enable in custom Bot.
  2. A valid Username and Password for the corresponding website, system, or web application account for API access.

The webhook URL is account-specific and cannot be transferred to any other account. This means that if you configure webhook for a custom Bot using a test account, you will have to recreate the alert and get a new webhook URL to configure in your Bot. The following URL is an example webhook URL.

Configuring the Webhook Bot

This procedure describes the generic steps to configure a webhook for a custom Bot using a webhook URL endpoint.

  1. Log on to your application that you want to add a webhook to, and depending on your application, select Settings, Repository properties, Integrations, or Add Ons.
  2. You may have to select Webhook and then in the URL field, or Callback URL field, enter the webhook URL for the alert.
  3. Some applications allow you to define or select from a list which events in the application will initiate a alert message.
  4. In some cases, you must also define, or you may be able to customize the payload data sent to when the event occurs.
  5. Save and close the dialog.

Creating the Payload

When you select or define the payload sent to the webhook URL, you must adhere to the following payload requirements:

  • HTTP method – Set to POST
  • Payload Content Type – Set to JSON
  • Payload – Valid JSON using two required key/value pairs. Any other key/value pair included in the payload is ignored. For example:
    "title": "The title of my alert",
    "description": "The message body of the alert"

You can validate your incoming webhook payload using cURL commands as follows:
curl -X POST -H "Content-Type: application/json" -d '{"title":"alert title goes here","description":"alert body content goes here"}'
After the webhook is configured for your custom Bot, when any of the events occur in the corresponding website, system, or web application, a message is displayed in the Alerts section for the account defined for the webhook.