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

Adding the Sunshine Conversations Channel

Virtual Assistants built on the Kore.ai XO Platform can be deployed on the Sunshine Conversations platform. This channel integration supports conversations with virtual assistants and provides a seamless hand-off to agents on Zendesk.

Authorizing the Kore.ai Integration to Sunshine Conversations

To enable the integration, you need to provide authorization using your Zendesk credentials. Follow the steps below to complete the OAuth-based authorization:

  1. Log into the Kore.ai XO Platform.
  2. Navigate to Deploy → Channels → Sunshine Conversations Channel.
  3. Click the Authorize button under Configurations on the Sunshine Conversations panel.
  4. On the Zendesk subdomain page, provide the subdomain and click Sign in.
  5. On the Zendesk sign-in page, provide your login credentials and click Sign in.
  6. After you have signed in successfully, a pop-up window will appear asking you to allow Kore.ai to access your Zendesk account. Click on Allow.
  7. Once the integrated is created successfully, you’ll be redirected to the Kore.ai XO Platform to complete the channel enablement process.

Switchboard Integration for Agent Handoff

The Kore.ai XO Platform lets you hand off the conversation to your Zendesk agents via the Zendesk Switchboard using the Agent Transfer node. 

The Switchboard Integration API is used to route the user’s conversations from Zendesk to the XO platform. This API has a pass control system to decide whether the conversation is to be routed to a Bot or a live agent.

The Pass Control action is triggered as a part of the event where the conversation is switched to the Bot or the agent helpdesk, and also during conversation closure. 

Developers can define custom metadata to be sent with the existing metadata from the XO Platform to Zendesk. The additional metadata can also be used to create a Zendesk ticket.

Capturing the Session Closure Metadata

The Zendesk Sunshine Configuration flow lets you enable the Session Closure Metadata field to let Kore.ai capture the metadata and share it with Zendesk as part of the pass control event triggered when the conversation is transferred to the agent’s helpdesk, or when closing a conversation session. The metadata is captured using the key-value pair you provide during the configuration. 

However, providing the key and value inputs when you enable Session Closure Metadata is optional. 

For example: When you provide SessionKey as key and apikeyvalue as value, Kore.ai generates the field variable SessionKey.apikeyvalue to fetch the session API key and pass it to Zendesk as metadata. Please refer to Step 7 here for configuring Session Closure Metadata.

Important Information on Session Closure Metadata

  • The Platform does not trigger the session closure message when the Agent transfer is initiated, and the conversation is not handed over back to the platform again.
  • When the Conversation is handed over to the Platform after the agent transfer, the session closure functionality works as usual.
  • For all the new bots or existing bots that do not have at least one SessionClosure metadata tag, the SessionClosure switch is turned off by default.
  • For all the existing bots that have at least one SessionClosure metadata tag, the switch is turned on by default.
  •  The Platform introduces the KoreUtil.getSunshineConversationsMetadata() function to let a Bot developer fetch the stored metadata (Get API operation), and use it for the following:
    • Entities where JavaScript is supported like advanced messages for a prompt, script nodes, etc.
    • Simple messages like plain text prompts.
  • Any additional changes or updates to the channel configurations should go through the Bot Publish cycle.

Selecting the Default and Next Integrations for Transferring Control

When you have a pre-existing switchboard integration, the XO Platform allows you to configure it as the default for the initial pass control during conversation initiation. Alternatively, you can select the Kore switchboard integration to designate the pass control.

You can review and edit these Switchboard integrations for newly created or pre-existing channel configurations in the Switchboard Configuration window. The Switchboard Configuration includes the Default Switchboard Integration for initiating conversations and the Next Switchboard Integration to transfer control after conversation session closure and the completion of agent conversations. Please refer to Step 4  here for more information.

Steps to Set up Agent Handoff

    1. Enable the Enable Agent Handoff option under Configurations in the Sunshine Conversations panel.
    2. From the Zendesk Admin Center, navigate to Apps & Integrations and click the Conversations API menu option to get your API Key and API Secret. Please get in touch with your Zendesk sales representative if you don’t see this menu.
    3. Paste these values in their respective fields on the Kore.ai platform under Sunshine Conversations > Configurations > OAuth > Enable Agent Handoff section.
    4. Click Configure for Switchboard Integration to set up the integrations available in your Sunshine Conversations account app.
    5. Select the required option for the following integrations in the Switchboard Configuration window:
      • Default Switchboard Integration: Select the primary contact point for users in your Sunshine Conversations application.
      • Next Switchboard Integration to Kore.ai: Select the next switchboard integration to which the control of a VA conversation is passed from Kore.ai.
      • Next Switchboard Integration to Agent: Select the next switchboard integration to which control is transferred after an agent conversation with a user.

The options listed include the default mapped integrations and others available in your Sunshine Developer account.

  • After selecting the above fields, click Done.
  • On the Zendesk Sunshine Configurations window, follow either step below to set Session Closure Metadata:

 

  • Disable the toggle switch if you don’t want the Platform to pass the session metadata to Zendesk.
  • Enable SessionClosure Metadata, and do one of the following:
    • Provide at least one Key and Value input (optional) to allow Kore.ai to capture the session metadata using the switchboard integration API and share it with Zendesk.
      Adding these parameters and saving the configuration will create a Zendesk ticket with the conversation details and close it.
    • Skip the Key-Value input and move to the next step.
      Not adding these parameters will create a Zendesk ticket with the conversation details but not close it.
  1. Select Yes for Enable Channel.
  2. Click Save.

Adding the Sunshine Conversations Channel

Virtual Assistants built on the Kore.ai XO Platform can be deployed on the Sunshine Conversations platform. This channel integration supports conversations with virtual assistants and provides a seamless hand-off to agents on Zendesk.

Authorizing the Kore.ai Integration to Sunshine Conversations

To enable the integration, you need to provide authorization using your Zendesk credentials. Follow the steps below to complete the OAuth-based authorization:

  1. Log into the Kore.ai XO Platform.
  2. Navigate to Deploy → Channels → Sunshine Conversations Channel.
  3. Click the Authorize button under Configurations on the Sunshine Conversations panel.
  4. On the Zendesk subdomain page, provide the subdomain and click Sign in.
  5. On the Zendesk sign-in page, provide your login credentials and click Sign in.
  6. After you have signed in successfully, a pop-up window will appear asking you to allow Kore.ai to access your Zendesk account. Click on Allow.
  7. Once the integrated is created successfully, you’ll be redirected to the Kore.ai XO Platform to complete the channel enablement process.

Switchboard Integration for Agent Handoff

The Kore.ai XO Platform lets you hand off the conversation to your Zendesk agents via the Zendesk Switchboard using the Agent Transfer node. 

The Switchboard Integration API is used to route the user’s conversations from Zendesk to the XO platform. This API has a pass control system to decide whether the conversation is to be routed to a Bot or a live agent.

The Pass Control action is triggered as a part of the event where the conversation is switched to the Bot or the agent helpdesk, and also during conversation closure. 

Developers can define custom metadata to be sent with the existing metadata from the XO Platform to Zendesk. The additional metadata can also be used to create a Zendesk ticket.

Capturing the Session Closure Metadata

The Zendesk Sunshine Configuration flow lets you enable the Session Closure Metadata field to let Kore.ai capture the metadata and share it with Zendesk as part of the pass control event triggered when the conversation is transferred to the agent’s helpdesk, or when closing a conversation session. The metadata is captured using the key-value pair you provide during the configuration. 

However, providing the key and value inputs when you enable Session Closure Metadata is optional. 

For example: When you provide SessionKey as key and apikeyvalue as value, Kore.ai generates the field variable SessionKey.apikeyvalue to fetch the session API key and pass it to Zendesk as metadata. Please refer to Step 7 here for configuring Session Closure Metadata.

Important Information on Session Closure Metadata

  • The Platform does not trigger the session closure message when the Agent transfer is initiated, and the conversation is not handed over back to the platform again.
  • When the Conversation is handed over to the Platform after the agent transfer, the session closure functionality works as usual.
  • For all the new bots or existing bots that do not have at least one SessionClosure metadata tag, the SessionClosure switch is turned off by default.
  • For all the existing bots that have at least one SessionClosure metadata tag, the switch is turned on by default.
  •  The Platform introduces the KoreUtil.getSunshineConversationsMetadata() function to let a Bot developer fetch the stored metadata (Get API operation), and use it for the following:
    • Entities where JavaScript is supported like advanced messages for a prompt, script nodes, etc.
    • Simple messages like plain text prompts.
  • Any additional changes or updates to the channel configurations should go through the Bot Publish cycle.

Selecting the Default and Next Integrations for Transferring Control

When you have a pre-existing switchboard integration, the XO Platform allows you to configure it as the default for the initial pass control during conversation initiation. Alternatively, you can select the Kore switchboard integration to designate the pass control.

You can review and edit these Switchboard integrations for newly created or pre-existing channel configurations in the Switchboard Configuration window. The Switchboard Configuration includes the Default Switchboard Integration for initiating conversations and the Next Switchboard Integration to transfer control after conversation session closure and the completion of agent conversations. Please refer to Step 4  here for more information.

Steps to Set up Agent Handoff

    1. Enable the Enable Agent Handoff option under Configurations in the Sunshine Conversations panel.
    2. From the Zendesk Admin Center, navigate to Apps & Integrations and click the Conversations API menu option to get your API Key and API Secret. Please get in touch with your Zendesk sales representative if you don’t see this menu.
    3. Paste these values in their respective fields on the Kore.ai platform under Sunshine Conversations > Configurations > OAuth > Enable Agent Handoff section.
    4. Click Configure for Switchboard Integration to set up the integrations available in your Sunshine Conversations account app.
    5. Select the required option for the following integrations in the Switchboard Configuration window:
      • Default Switchboard Integration: Select the primary contact point for users in your Sunshine Conversations application.
      • Next Switchboard Integration to Kore.ai: Select the next switchboard integration to which the control of a VA conversation is passed from Kore.ai.
      • Next Switchboard Integration to Agent: Select the next switchboard integration to which control is transferred after an agent conversation with a user.

The options listed include the default mapped integrations and others available in your Sunshine Developer account.

  • After selecting the above fields, click Done.
  • On the Zendesk Sunshine Configurations window, follow either step below to set Session Closure Metadata:

 

  • Disable the toggle switch if you don’t want the Platform to pass the session metadata to Zendesk.
  • Enable SessionClosure Metadata, and do one of the following:
    • Provide at least one Key and Value input (optional) to allow Kore.ai to capture the session metadata using the switchboard integration API and share it with Zendesk.
      Adding these parameters and saving the configuration will create a Zendesk ticket with the conversation details and close it.
    • Skip the Key-Value input and move to the next step.
      Not adding these parameters will create a Zendesk ticket with the conversation details but not close it.
  1. Select Yes for Enable Channel.
  2. Click Save.
Menu