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. Builder
  5. Alert Task
  6. Alert Task – OAuth v2

Alert Task – OAuth v2

We have seen how an Alert task can be set up in the Kore.ai XO Platform  here. In this article, we will see how alert task authorization can be set up using the OAuth v2.

How it Works 

  1. The Kore.ai application redirects the user to a login dialog at the web application.
  2. The user authenticates.
  3. The web application redirects the user back to the Kore.ai application with an access token.
  4. The Kore.ai application validates the access token.
  5. The access token allows the Kore.ai application to access a protected resource at the provider, on behalf of the user.

General Setup

OAuth v2 is the new version of the open protocol to allow secure authorization in a simple and standard method from web, mobile, and desktop applications. To use oAuth v2, you must first register an account with the web application as you will need the log-in credentials for that application to configure the settings for the Authorization Mechanism.

To begin your configuration, follow the steps below:

    1. Select the VA you want to work with.
    2. Go to Build > Conversation Skills > Alert Tasks
    3. Select the task you want to work with. 
    4. Click the API Request tab within the Alert Task.
    5. Expand the Authorization section and click Create New to configure a new authorization.

    6. Next, the New Authorization Mechanism window opens, as shown in the illustration below.

To configure OAuth1 for your Alert Task, please configure each area presented below. 

Form Fields

To configure oAuth v2, define the fields described in the following table.

FIELD NAME

DESCRIPTION

Authorization Type

Set to oAuth v2.

Callback URL

The URL used by the web application or web service to redirect the end-user after end-user authorization is complete. This value, https://idp.kore.ai/workflows/callback/ is provided as a read-only value by the Kore.ai application when you define oAuth v2 settings.

Identity Provider Name

The name of the web application or web service, for example, Asana. This field is required.

Client ID

The ID of the Kore.ai client.

Client Secret Key

The value provided as the Kore.ai application authentication based on the Client ID to the web application.

Authorization URL

The URL used to obtain end-user authorization for the Kore.ai application to access the web application or web service using the access token. This field is required.

Token Request URL

The URL used by the Kore.ai application to obtain an unauthorized request token. A request token is a value used by the Kore.ai application to obtain authorization from the end-user to obtain an access token. After end-user authorization, an access token can be requested by the Kore.ai application. This field is required.

Scope

If the web service requires additional values for authorization, add one or more Key/Value pairs. For example, some Bot web services support using a scope key using read-only, write, or both as the value.

Refresh Token URL

Add the refresh token URL that you want to use for this authentication.

Auth Error Status Code

When there is an error in authentication, use this field to provide a status code for the particular error.

Description

Provide a description for your Alert Task authentication. 

Tenancy

If required, in the Subdomain section, select Yes if the base URL for a web application or user interface uses a tenant name in the URL. For example, kore is the tenant organization for a web service using tenants as www.kore.someCompany.com.

In the following example configuration, the tenancy URL contains the {tenant} organization placeholder.

Additional Fields

  1. Click + Add Additional Fields to open the Additional Fields window, and then enter one or more key/value pairs that represent additional authorization input fields if required as shown in the following illustration. 

  2. Specify the following fields:
    1. Field Key – The name of the custom field to specify for authorization.
    2. Value – The value of the custom field to specify for the authorization.
    3. Click Add to save the Additional Field.
  3. To add more Additional Fields, click Add in the Additional Fields section.

Authorization Fields

By default, authorization fields are configured as part of the header of the task request message. If your task request requires additional authorization fields or the expected authorization is not part of the header, for example, a verification code,

  1. Click + Add Authorization Field and then define the fields as shown in the following illustration.
  2. In the Field Type field, you can select one of the following depending on where in the task request message and the type of authorization fields that are required.
    1. Header – The VA expects the authorization fields as part of the header of the request.
    2. Payload – The VA expects the authorization fields as part of the content of the body of the request.
    3. Query String – The VA expects the authorization fields as a uery in the body of the request.
    4. Path Param – The VA expects the authorization fields as part of the URL path for the request.
  3. In the Field Key field, enter the name of the field for the selected Field Type.
  4. In the Field Value field, enter the value for the Field Key specified.
  5. Click Add. The new authorization field is added in the Authorization Fields section.
  6. To add additional authorization fields, click Add in the Authorization Fields section.

Click Save Auth to save the authorization settings and close the New Authorization Mechanism dialog.

Testing

After you save the authorization, you can test it using the Authorization page.

    1. Click Test Authorization before continuing to develop the remaining steps of your task.
    2. After you click Test Authorization, the test is executed using the authentication token URLs and the Client ID and Client Secret Key. If the tenancy was defined, the Test Authorization window is displayed as shown in the following illustration.
    3. Click Test to begin the authorization test. When the validation of authentication is complete, the Test Authorization window is closed and the results of the validation, either success or failure, is displayed to the immediate right of the Test Authorization button. If the authorization fails, the Auth Test Failed message is displayed along with the Headers and Response tabs as shown in the following illustration.

 

Alert Task – OAuth v2

We have seen how an Alert task can be set up in the Kore.ai XO Platform  here. In this article, we will see how alert task authorization can be set up using the OAuth v2.

How it Works 

  1. The Kore.ai application redirects the user to a login dialog at the web application.
  2. The user authenticates.
  3. The web application redirects the user back to the Kore.ai application with an access token.
  4. The Kore.ai application validates the access token.
  5. The access token allows the Kore.ai application to access a protected resource at the provider, on behalf of the user.

General Setup

OAuth v2 is the new version of the open protocol to allow secure authorization in a simple and standard method from web, mobile, and desktop applications. To use oAuth v2, you must first register an account with the web application as you will need the log-in credentials for that application to configure the settings for the Authorization Mechanism.

To begin your configuration, follow the steps below:

    1. Select the VA you want to work with.
    2. Go to Build > Conversation Skills > Alert Tasks
    3. Select the task you want to work with. 
    4. Click the API Request tab within the Alert Task.
    5. Expand the Authorization section and click Create New to configure a new authorization.

    6. Next, the New Authorization Mechanism window opens, as shown in the illustration below.

To configure OAuth1 for your Alert Task, please configure each area presented below. 

Form Fields

To configure oAuth v2, define the fields described in the following table.

FIELD NAME

DESCRIPTION

Authorization Type

Set to oAuth v2.

Callback URL

The URL used by the web application or web service to redirect the end-user after end-user authorization is complete. This value, https://idp.kore.ai/workflows/callback/ is provided as a read-only value by the Kore.ai application when you define oAuth v2 settings.

Identity Provider Name

The name of the web application or web service, for example, Asana. This field is required.

Client ID

The ID of the Kore.ai client.

Client Secret Key

The value provided as the Kore.ai application authentication based on the Client ID to the web application.

Authorization URL

The URL used to obtain end-user authorization for the Kore.ai application to access the web application or web service using the access token. This field is required.

Token Request URL

The URL used by the Kore.ai application to obtain an unauthorized request token. A request token is a value used by the Kore.ai application to obtain authorization from the end-user to obtain an access token. After end-user authorization, an access token can be requested by the Kore.ai application. This field is required.

Scope

If the web service requires additional values for authorization, add one or more Key/Value pairs. For example, some Bot web services support using a scope key using read-only, write, or both as the value.

Refresh Token URL

Add the refresh token URL that you want to use for this authentication.

Auth Error Status Code

When there is an error in authentication, use this field to provide a status code for the particular error.

Description

Provide a description for your Alert Task authentication. 

Tenancy

If required, in the Subdomain section, select Yes if the base URL for a web application or user interface uses a tenant name in the URL. For example, kore is the tenant organization for a web service using tenants as www.kore.someCompany.com.

In the following example configuration, the tenancy URL contains the {tenant} organization placeholder.

Additional Fields

  1. Click + Add Additional Fields to open the Additional Fields window, and then enter one or more key/value pairs that represent additional authorization input fields if required as shown in the following illustration. 

  2. Specify the following fields:
    1. Field Key – The name of the custom field to specify for authorization.
    2. Value – The value of the custom field to specify for the authorization.
    3. Click Add to save the Additional Field.
  3. To add more Additional Fields, click Add in the Additional Fields section.

Authorization Fields

By default, authorization fields are configured as part of the header of the task request message. If your task request requires additional authorization fields or the expected authorization is not part of the header, for example, a verification code,

  1. Click + Add Authorization Field and then define the fields as shown in the following illustration.
  2. In the Field Type field, you can select one of the following depending on where in the task request message and the type of authorization fields that are required.
    1. Header – The VA expects the authorization fields as part of the header of the request.
    2. Payload – The VA expects the authorization fields as part of the content of the body of the request.
    3. Query String – The VA expects the authorization fields as a uery in the body of the request.
    4. Path Param – The VA expects the authorization fields as part of the URL path for the request.
  3. In the Field Key field, enter the name of the field for the selected Field Type.
  4. In the Field Value field, enter the value for the Field Key specified.
  5. Click Add. The new authorization field is added in the Authorization Fields section.
  6. To add additional authorization fields, click Add in the Authorization Fields section.

Click Save Auth to save the authorization settings and close the New Authorization Mechanism dialog.

Testing

After you save the authorization, you can test it using the Authorization page.

    1. Click Test Authorization before continuing to develop the remaining steps of your task.
    2. After you click Test Authorization, the test is executed using the authentication token URLs and the Client ID and Client Secret Key. If the tenancy was defined, the Test Authorization window is displayed as shown in the following illustration.
    3. Click Test to begin the authorization test. When the validation of authentication is complete, the Test Authorization window is closed and the results of the validation, either success or failure, is displayed to the immediate right of the Test Authorization button. If the authorization fails, the Auth Test Failed message is displayed along with the Headers and Response tabs as shown in the following illustration.

 

Menu