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. Channel Enablement
  5. Adding the Mattermost Channel

Adding the Mattermost Channel

You can connect Kore.ai assistants to your Mattermost account using either:

Before you begin, ensure that you have access to the administrative functions of your Mattermost account.

WebHook based Integration

Step 1: Setup Outgoing Webhook

  • Login to your Mattermost account
  • From the Main Menu choose Integrations.

  • Select the Outgoing Webhooks menu and click Add Outgoing Webhook.

  • Provide required information as per the below image.
    • Enter your preferred values for Title, Description and Bot Name fields.
    • Choose application/json as Content Type.
    • If you would like your bot to be available only for a specific channel, then choose the required channel from the Channel dropdown.
    • Provide your Kore.ai assistant Name in the Trigger Words field.
    • Copy the Callback URL for the Kore VA (located in the XO Platform > Deploy > Channels > Mattermost)  and provide it in the Callback URLs field.
    • Click on Save to complete the Outgoing Webhook setup.
    • You will be redirected to the confirmation page with the Token displayed.
    • Copy this Token and provide it in the ‘Outgoing Webhook Token’ field present in the XO Platform Channel Configurations section.


Step 2: Setup Incoming Webhook

  • Select the ‘Incoming Webhooks’ menu and click ‘Add Incoming Webhook’.
  • Provide required information as per the below image.
    • Enter your preferred values for Title, Description and Username fields.
    • Choose a default Channel. Kore.ai VAs always respond back in the channel from which the user input is received.
    • Do not select the Lock to this channel option.

  • Click on Save to complete the Incoming Webhook setup.
  • You would be redirected to the confirmation page along with the URL associated with this newly created incoming webhook.
  • Copy this URL and provide it in the ‘Incoming Webhook URL’ field in the Kore Bot Channel Configurations section.

WebSocket based Integration

Step 1: Enable Personal Access Tokens

To enable a WebSocket connection, you would need to create a Mattermost account to be provisioned as a bot.

  1. First, enable usage of Personal Access Tokens to allow your Mattermost users to generate personal access tokens.
  2. Personal access tokens are used to authenticate and provide full access to an account.
    1. Login to Mattermost from an account that has access to System Console.
    2. Go to System Console > Integrations > Integrations Management.
    3. Locate the Enable Personal Access Tokens setting, set it to true, and Save.

Step 2: Create an Account to be Provisioned as a Bot

  1. From your Mattermost account, go to Integrations > Bot Accounts > Add Bot Account.
  2. Configure the Bot’s details: 
    1. Choose a Username.
    2. Add an Icon, a Display Name.and a Description.
    3. Choose the Member role.
    4. Select additional permissions for the account: 
      1. post:all to allow the bot to post to all Mattermost channels including direct messages.
      2. post:channels: to allow the bot to post to all Mattermost public channels, but not in direct messages or private channels.
    5. Click Create Bot Account to complete the setup.

  3. A success page will be shown to you next, where you will also find the access token you can use to connect to this assistant.

XO Platform Channel Configuration

To configure the XO Platform channel, after having completed the setup in Mattermost, please follow the steps below:

  1. In the XO Platform, select the Assistant that you are working with. 
  2. Go to Deploy > Channels > Mattermost.
  3. Select the Configuration tab and provide the following details, which you have just generated in Mattermost:
    1. Outgoing Webhook Token.
    2. Incoming Webhook URL.
  4. Select Yes to enable the channel.
  5. Click Save to save your configuration.

After the channel is enabled and all configurations are verified, you can optionally publish the assistant to make it available for end-users, with the new channel. Learn more about Publishing your Virtual Assistant.

To learn more about working with Channels within the Kore.ai XO Platform, please see Channel Enablement.

Adding the Mattermost Channel

You can connect Kore.ai assistants to your Mattermost account using either:

Before you begin, ensure that you have access to the administrative functions of your Mattermost account.

WebHook based Integration

Step 1: Setup Outgoing Webhook

  • Login to your Mattermost account
  • From the Main Menu choose Integrations.

  • Select the Outgoing Webhooks menu and click Add Outgoing Webhook.

  • Provide required information as per the below image.
    • Enter your preferred values for Title, Description and Bot Name fields.
    • Choose application/json as Content Type.
    • If you would like your bot to be available only for a specific channel, then choose the required channel from the Channel dropdown.
    • Provide your Kore.ai assistant Name in the Trigger Words field.
    • Copy the Callback URL for the Kore VA (located in the XO Platform > Deploy > Channels > Mattermost)  and provide it in the Callback URLs field.
    • Click on Save to complete the Outgoing Webhook setup.
    • You will be redirected to the confirmation page with the Token displayed.
    • Copy this Token and provide it in the ‘Outgoing Webhook Token’ field present in the XO Platform Channel Configurations section.


Step 2: Setup Incoming Webhook

  • Select the ‘Incoming Webhooks’ menu and click ‘Add Incoming Webhook’.
  • Provide required information as per the below image.
    • Enter your preferred values for Title, Description and Username fields.
    • Choose a default Channel. Kore.ai VAs always respond back in the channel from which the user input is received.
    • Do not select the Lock to this channel option.

  • Click on Save to complete the Incoming Webhook setup.
  • You would be redirected to the confirmation page along with the URL associated with this newly created incoming webhook.
  • Copy this URL and provide it in the ‘Incoming Webhook URL’ field in the Kore Bot Channel Configurations section.

WebSocket based Integration

Step 1: Enable Personal Access Tokens

To enable a WebSocket connection, you would need to create a Mattermost account to be provisioned as a bot.

  1. First, enable usage of Personal Access Tokens to allow your Mattermost users to generate personal access tokens.
  2. Personal access tokens are used to authenticate and provide full access to an account.
    1. Login to Mattermost from an account that has access to System Console.
    2. Go to System Console > Integrations > Integrations Management.
    3. Locate the Enable Personal Access Tokens setting, set it to true, and Save.

Step 2: Create an Account to be Provisioned as a Bot

  1. From your Mattermost account, go to Integrations > Bot Accounts > Add Bot Account.
  2. Configure the Bot’s details: 
    1. Choose a Username.
    2. Add an Icon, a Display Name.and a Description.
    3. Choose the Member role.
    4. Select additional permissions for the account: 
      1. post:all to allow the bot to post to all Mattermost channels including direct messages.
      2. post:channels: to allow the bot to post to all Mattermost public channels, but not in direct messages or private channels.
    5. Click Create Bot Account to complete the setup.

  3. A success page will be shown to you next, where you will also find the access token you can use to connect to this assistant.

XO Platform Channel Configuration

To configure the XO Platform channel, after having completed the setup in Mattermost, please follow the steps below:

  1. In the XO Platform, select the Assistant that you are working with. 
  2. Go to Deploy > Channels > Mattermost.
  3. Select the Configuration tab and provide the following details, which you have just generated in Mattermost:
    1. Outgoing Webhook Token.
    2. Incoming Webhook URL.
  4. Select Yes to enable the channel.
  5. Click Save to save your configuration.

After the channel is enabled and all configurations are verified, you can optionally publish the assistant to make it available for end-users, with the new channel. Learn more about Publishing your Virtual Assistant.

To learn more about working with Channels within the Kore.ai XO Platform, please see Channel Enablement.

Menu