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
Web SDK
How the Web SDK Works
SDK Security
SDK Registration
Web Socket Connect and RTM
Tutorials
Widget SDK Tutorial
Web SDK Tutorial
BotKit SDK
BotKit SDK Deployment Guide
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Bot Store
  5. Adding Bots
  6. Adding a CircleCI Bot

Adding a CircleCI Bot

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

About the Kore.ai Bot for CircleCI

DIYCircleCILogo CircleCI is a continuous integration and deployment platform that lets you quickly and securely build, test, and deploy your applications.

Integration Type Webhook – Connect to this Bot using a webhook integration where the web application pushes message notifications in near real time.
Category Developer Tools – This Bot is available in the Kore.ai application in the Developer Tools category.

Configuring CircleCI 

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

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

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

Configuring Webhook

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

  1. Log on to CircleCI, and then click the Settings DIYSettingsIcon icon located to the immediate right of your repository.
  2. On the Project Settings navigation pane, in the Notifications section, click Webhook Notifications. The Webhooks page is displayed.
  3. Click the circle.yml file link
  4. In the root folder of your repository, create or add the following code in the circle.yml file:

notify: webhooks: # A list of hashes representing hooks. Only the url field is supported. - url: https://Yourcompany.kore.com/hooks/c6089802f36250c179dcb1aa29afd24c

where the – url: property is the Kore.ai webhook URL for the alert.

5. Save and publish the repository.

Note: By default, all events for this Bot generate Kore.ai alert messages. To reduce the number of notifications, this Bot may have filters that can be defined when you set up the alert in your Kore.ai account.

Sample circle.yml file

The following code is a sample circle.yml file that includes the notify section at the bottom for Kore.ai alert configuration. For more information, see the Notifications section in Configuring CircleCI in the CircleCI documentation.
The sections in your circle.yml file depend on your requirements.

## Customize the test machine
machine:
  timezone:
    America/Los_Angeles # Set the timezone
  # Version of ruby to use
  ruby:
    version:
      1.8.7-p358-falcon-perf
  # Override /etc/hosts
  hosts:
    circlehost: 127.0.0.1
    dev.mycompany.com: 127.0.0.1
  # Add some environment variables
  environment:
    CIRCLE_ENV: test
    DATABASE_URL: postgres://ubuntu:@127.0.0.1:5432/circle_test
## Customize checkout
checkout:
  post:
    - git submodule sync
    - git submodule update --init # use submodules
## Customize dependencies
dependencies:
  pre:
    - npm install coffeescript # install from a different package manager
    - gem uninstall bundler # use a custom version of bundler
    - gem install bundler --pre
  override:
    - bundle install: # note ':' here
        timeout: 180 # fail if command has no output for 3 minutes
  # we automatically cache and restore many dependencies between
  # builds. If you need to, you can add custom paths to cache:
  cache_directories:
    - "custom_1"   # relative to the build directory
    - "~/custom_2" # relative to the user's home directory
## Customize database setup
database:
  override:
    # replace CircleCI's generated database.yml
    - cp config/database.yml.ci config/database.yml
    - bundle exec rake db:create db:schema:load
## Customize test commands
test:
  override:
    - phpunit test/unit-tests # use PHPunit for testing
  post:
    - bundle exec rake jasmine:ci: # add an extra test type
        environment:
          RAILS_ENV: test
          RACK_ENV: test
## Customize deployment commands
deployment:
  staging:
    branch: master
    heroku:
      appname: foo-bar-123
## Custom notifications
notify:
  webhooks:
    # A list of hashes representing hooks. Only the url field is supported.
    - url: https://company.kore.com/hooks/c6089802f36250c179dcb1aa29afd24c

You can setup message notifications to your Kore.ai account using a CircleCI webhook. Click , click Get notified when…, click Build Updates via Webhook, 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 CircleCI Webhooks.
  • optionally customize the Task Name 
  • optionally customize the Short Description
  • enable or disable Mute task notifications.

Next Steps

After the webhook is configured in CircleCI, when any of the events occur in CircleCI, a message is displayed on the Bots tab in the Messages section for the Kore.ai account.

Adding a CircleCI Bot

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

About the Kore.ai Bot for CircleCI

DIYCircleCILogo CircleCI is a continuous integration and deployment platform that lets you quickly and securely build, test, and deploy your applications.

Integration Type Webhook – Connect to this Bot using a webhook integration where the web application pushes message notifications in near real time.
Category Developer Tools – This Bot is available in the Kore.ai application in the Developer Tools category.

Configuring CircleCI 

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

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

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

Configuring Webhook

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

  1. Log on to CircleCI, and then click the Settings DIYSettingsIcon icon located to the immediate right of your repository.
  2. On the Project Settings navigation pane, in the Notifications section, click Webhook Notifications. The Webhooks page is displayed.
  3. Click the circle.yml file link
  4. In the root folder of your repository, create or add the following code in the circle.yml file:

notify: webhooks: # A list of hashes representing hooks. Only the url field is supported. - url: https://Yourcompany.kore.com/hooks/c6089802f36250c179dcb1aa29afd24c

where the – url: property is the Kore.ai webhook URL for the alert.

5. Save and publish the repository.

Note: By default, all events for this Bot generate Kore.ai alert messages. To reduce the number of notifications, this Bot may have filters that can be defined when you set up the alert in your Kore.ai account.

Sample circle.yml file

The following code is a sample circle.yml file that includes the notify section at the bottom for Kore.ai alert configuration. For more information, see the Notifications section in Configuring CircleCI in the CircleCI documentation.
The sections in your circle.yml file depend on your requirements.

## Customize the test machine
machine:
  timezone:
    America/Los_Angeles # Set the timezone
  # Version of ruby to use
  ruby:
    version:
      1.8.7-p358-falcon-perf
  # Override /etc/hosts
  hosts:
    circlehost: 127.0.0.1
    dev.mycompany.com: 127.0.0.1
  # Add some environment variables
  environment:
    CIRCLE_ENV: test
    DATABASE_URL: postgres://ubuntu:@127.0.0.1:5432/circle_test
## Customize checkout
checkout:
  post:
    - git submodule sync
    - git submodule update --init # use submodules
## Customize dependencies
dependencies:
  pre:
    - npm install coffeescript # install from a different package manager
    - gem uninstall bundler # use a custom version of bundler
    - gem install bundler --pre
  override:
    - bundle install: # note ':' here
        timeout: 180 # fail if command has no output for 3 minutes
  # we automatically cache and restore many dependencies between
  # builds. If you need to, you can add custom paths to cache:
  cache_directories:
    - "custom_1"   # relative to the build directory
    - "~/custom_2" # relative to the user's home directory
## Customize database setup
database:
  override:
    # replace CircleCI's generated database.yml
    - cp config/database.yml.ci config/database.yml
    - bundle exec rake db:create db:schema:load
## Customize test commands
test:
  override:
    - phpunit test/unit-tests # use PHPunit for testing
  post:
    - bundle exec rake jasmine:ci: # add an extra test type
        environment:
          RAILS_ENV: test
          RACK_ENV: test
## Customize deployment commands
deployment:
  staging:
    branch: master
    heroku:
      appname: foo-bar-123
## Custom notifications
notify:
  webhooks:
    # A list of hashes representing hooks. Only the url field is supported.
    - url: https://company.kore.com/hooks/c6089802f36250c179dcb1aa29afd24c

You can setup message notifications to your Kore.ai account using a CircleCI webhook. Click , click Get notified when…, click Build Updates via Webhook, 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 CircleCI Webhooks.
  • optionally customize the Task Name 
  • optionally customize the Short Description
  • enable or disable Mute task notifications.

Next Steps

After the webhook is configured in CircleCI, when any of the events occur in CircleCI, a message is displayed on the Bots tab in the Messages section for the Kore.ai account.

Menu