GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
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
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
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
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
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
SDK Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Data Tables and Views
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On (SSO)
Two-Factor Authentication (2FA)
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Bot Store
  5. Adding Bots
  6. Adding a Beanstalk Bot

Adding a Beanstalk Bot

Kore.ai provides integration for a built-in Beanstalk Bot that you can use to display message notifications and execute tasks directly from your messaging channel such as Kore.ai Messenger. To use the Beanstalk Bot, you just need to add the Bot to your channel and then configure the settings for the Bot, such as authentication to access Beanstalk and the notification messages that you want. For more information about other Kore.ai Bots, see Adding Bots

About the Kore.ai Bot for Beanstalk

DIYBeanstalkLogoBeanstalk is a Platform as a Service (PaaS) service from Amazon Web Services that allows users to create applications and push them to a definable set of AWS services. You can use this Bot to get updates, create comments, and request code reviews in your messaging channel.

Integration Type Webhook – Connect to this Bot using a webhook integration where the web application pushes message notifications in near real time.
Web Service – Connect to this Bot using a web service integration where Kore.ai polls the service for updates based on a specified interval.
Category Developer Tools – This Bot is available in the Kore.ai Bot Store in the Developer Tools category.
Channels Kore.ai – This Bot is available in the Kore.ai Messenger application.
Spark – This Bot is available in the Cisco Spark application.
Slack – This Bot is available in the Slack application.
Skype – This Bot is available in the Skype application.

Configuring Beanstalk 

To configure a Beanstalk webhook for Kore.ai, you must have a Beanstalk account with administrator access as well as API access to configure a webhook. If you don’t, you’ll need to contact the Beanstalk system administrator for your company. For more information, see the Beanstalk Help in the Beanstalk documentation.
To get started configuring the webhook in Beanstalk, you’ll need two things:

  1. The Kore.ai webhook URL provided when you set up an alert in your messaging channel for each alert that you want to enable in Beanstalk.
  2. A valid Username and Password for an account with Beanstalk API access.

The webhook URL is account-specific and cannot be transferred to any other account. This means that if you configure a Beanstalk webhook using a test account, you will have to recreate the alert and get a new webhook URL to configure in Beanstalk. The following URL is an example webhook URL.
https://app.kore.com/hooks/c6089802f36250c179dcb1aa29afd24c

Configuring Webhook Tasks

This procedure describes the steps in Beanstalk to configure a webhook using a Kore.ai webhook URL endpoint.

  1. Log on to Beanstalk, and then on the Repository tab, select a repository to create a webhook for.
  2. On the Settings tab, click Integration.
  3. In the list of integrations, select Modular Webhooks, and then click Add a webhook. The Add a webhook dialog is displayed.
  4. In the Name field, enter a name for the webhook configuration used in the Beanstalk user interface.
  5. In the URL field, enter the Kore.ai webhook URL for the alert.
  6. In the Select webhook triggers section, select one or more events that you want to get Kore.ai alert messages for.
  7. Click Activate to save the webhook configuration and close the Add a webhook dialog.

For more information, see Classic Webhooks Integration in the Beanstalk documentation.
To setup real-time notifications in your messaging channel using a Beanstalk webhook, for example, in the Kore.ai Messenger channel, click the New Task icon, click Get notified when…, click Information Updates, and then in the Setup Task dialog:

  • click the Activate button to generate a Webhook URL.
  • copy and save the URL, or click Email Instructions to send the URL to an email account. For more information, see Configuring Beanstalk Webhooks.
  • optionally, click the gray box in Filters to setup one or more filters to prevent message notifications for specified criteria. You can filter on one or more of the following:
    • Trigger
    • Click Done to save the filter.
  • optionally customize the Task Name 
  • optionally customize the Short Description
  • enable or disable Mute task notifications
  • and then click Finish.

Configuring Web Service Tasks

To configure web service tasks, you need to add the Beanstalk Bot from the Kore.ai Bot Store in your messaging channel, and then setup the task. After you add a web service task and are connected, you can perform tasks for Beanstalk and setup message notifications to get notified in your messaging channel when an event occurs in Beanstalk.
To setup an Beanstalk task in the Kore.ai Messenger channel, click the New Task icon, and then click one of the Beanstalk web services described in the following table.

TASK TO CONFIGURE THIS TASK…
Add Comment In the Perform Task dialog,

  • select a Repository
  • select a Changeset
  • enter a Comment
  • and then click Submit.

In a team room, you can enter the @beanstalk add_a_comment Bot command to invoke and configure this task.

Request code review In the Perform Task dialog,

  • enter a Repository
  • select a Target Branch
  • select a Source Branch
  • optionally select True or False to Merge.
  • optionally enter a Description
  • and then click Submit.

In a team room, you can enter the @beanstalk request_code_review Bot command to invoke and configure this task.

Next Steps

After the webhook is configured in Beanstalk, when any of the events occur in Beanstalk, a message is displayed on the Bots page in Kore.ai Messenger or your messaging channel.

Adding a Beanstalk Bot

Kore.ai provides integration for a built-in Beanstalk Bot that you can use to display message notifications and execute tasks directly from your messaging channel such as Kore.ai Messenger. To use the Beanstalk Bot, you just need to add the Bot to your channel and then configure the settings for the Bot, such as authentication to access Beanstalk and the notification messages that you want. For more information about other Kore.ai Bots, see Adding Bots

About the Kore.ai Bot for Beanstalk

DIYBeanstalkLogoBeanstalk is a Platform as a Service (PaaS) service from Amazon Web Services that allows users to create applications and push them to a definable set of AWS services. You can use this Bot to get updates, create comments, and request code reviews in your messaging channel.

Integration Type Webhook – Connect to this Bot using a webhook integration where the web application pushes message notifications in near real time.
Web Service – Connect to this Bot using a web service integration where Kore.ai polls the service for updates based on a specified interval.
Category Developer Tools – This Bot is available in the Kore.ai Bot Store in the Developer Tools category.
Channels Kore.ai – This Bot is available in the Kore.ai Messenger application.
Spark – This Bot is available in the Cisco Spark application.
Slack – This Bot is available in the Slack application.
Skype – This Bot is available in the Skype application.

Configuring Beanstalk 

To configure a Beanstalk webhook for Kore.ai, you must have a Beanstalk account with administrator access as well as API access to configure a webhook. If you don’t, you’ll need to contact the Beanstalk system administrator for your company. For more information, see the Beanstalk Help in the Beanstalk documentation.
To get started configuring the webhook in Beanstalk, you’ll need two things:

  1. The Kore.ai webhook URL provided when you set up an alert in your messaging channel for each alert that you want to enable in Beanstalk.
  2. A valid Username and Password for an account with Beanstalk API access.

The webhook URL is account-specific and cannot be transferred to any other account. This means that if you configure a Beanstalk webhook using a test account, you will have to recreate the alert and get a new webhook URL to configure in Beanstalk. The following URL is an example webhook URL.
https://app.kore.com/hooks/c6089802f36250c179dcb1aa29afd24c

Configuring Webhook Tasks

This procedure describes the steps in Beanstalk to configure a webhook using a Kore.ai webhook URL endpoint.

  1. Log on to Beanstalk, and then on the Repository tab, select a repository to create a webhook for.
  2. On the Settings tab, click Integration.
  3. In the list of integrations, select Modular Webhooks, and then click Add a webhook. The Add a webhook dialog is displayed.
  4. In the Name field, enter a name for the webhook configuration used in the Beanstalk user interface.
  5. In the URL field, enter the Kore.ai webhook URL for the alert.
  6. In the Select webhook triggers section, select one or more events that you want to get Kore.ai alert messages for.
  7. Click Activate to save the webhook configuration and close the Add a webhook dialog.

For more information, see Classic Webhooks Integration in the Beanstalk documentation.
To setup real-time notifications in your messaging channel using a Beanstalk webhook, for example, in the Kore.ai Messenger channel, click the New Task icon, click Get notified when…, click Information Updates, and then in the Setup Task dialog:

  • click the Activate button to generate a Webhook URL.
  • copy and save the URL, or click Email Instructions to send the URL to an email account. For more information, see Configuring Beanstalk Webhooks.
  • optionally, click the gray box in Filters to setup one or more filters to prevent message notifications for specified criteria. You can filter on one or more of the following:
    • Trigger
    • Click Done to save the filter.
  • optionally customize the Task Name 
  • optionally customize the Short Description
  • enable or disable Mute task notifications
  • and then click Finish.

Configuring Web Service Tasks

To configure web service tasks, you need to add the Beanstalk Bot from the Kore.ai Bot Store in your messaging channel, and then setup the task. After you add a web service task and are connected, you can perform tasks for Beanstalk and setup message notifications to get notified in your messaging channel when an event occurs in Beanstalk.
To setup an Beanstalk task in the Kore.ai Messenger channel, click the New Task icon, and then click one of the Beanstalk web services described in the following table.

TASK TO CONFIGURE THIS TASK…
Add Comment In the Perform Task dialog,

  • select a Repository
  • select a Changeset
  • enter a Comment
  • and then click Submit.

In a team room, you can enter the @beanstalk add_a_comment Bot command to invoke and configure this task.

Request code review In the Perform Task dialog,

  • enter a Repository
  • select a Target Branch
  • select a Source Branch
  • optionally select True or False to Merge.
  • optionally enter a Description
  • and then click Submit.

In a team room, you can enter the @beanstalk request_code_review Bot command to invoke and configure this task.

Next Steps

After the webhook is configured in Beanstalk, when any of the events occur in Beanstalk, a message is displayed on the Bots page in Kore.ai Messenger or your messaging channel.

Menu