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 – Authorization using API Key

Alert Task – Authorization using API Key

We have seen how an Alert task can be set up in the Kore.ai XO Platform here. In this section, we will see how to configure API authorization.

API Key Setup Overview

An API key can act as both a unique identifier and a secret token for identification as well as authentication to provide a set of access rights on the associated API. Instead of prompting the end-user for both a username and password for access, the user is prompted only for an API key when configuring the task. To use the API Key Authorization Type, you must first register an account with the web application you want to work with, and then generate an API Key for that application

To authorize an API key,

  1. Go to Alert Tasks and create or select the task you want to work with. 
  2. Under API Request, expand Authorization.
  3. Select the Authorization PRovider. If none is available, create it by clicking on Create New.
  4. Ensure that your selected Authorization Type is API Key. Below is an illustration of the fields that you will need to provide information for in order to authorize the API.
  5. Name your API to get started, then let us go through these fields in detail.

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, where [tenant] including the braces represents the tenant name.

Form Fields

If the default username and password fields do not meet your needs, you can add new fields displayed to the end-user by adding authorization form fields,  for example, if a PIN code is required in the authentication process, in addition to the Username and Password form fields.

To add fields on the authorization form,Click + Add Form Field. 

The following illustration is an example of a definition to add a password field to the authorization dialog.

 

The following table describes the fields used to define an authorization IDP form field.

FIELD NAME

DESCRIPTION

Title of Field

Specify the name of the field displayed to the end-user in the authentication dialog.

Field Key

The value represents the end-user input value to the authenticating service.

Help Hint

The help text displayed in the field to describe what should be entered into the field.

Field Type

When Advanced Options is selected, specify the type of field displayed in the end-user interface to collect the user input assigned as the value for the Field Key, one of:

  • Textbox
  • Password

Mandatory

When Advanced Options is selected, select if the end-user must define this field to complete authentication.

Data Type

When Advanced Options is selected, specify the type of data expected as input from the end-user, for example, String.

Visibility

When Advanced Options is selected, specify if the authentication field should be visible, hidden, or displayed as read-only.

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, social security number or PIN,

  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.
    Header – The VA expects the authorization fields as part of the header of the request.Payload – The VA expects the authorization fields as part of the content of the body of the request.Query String – The VA expects the authorization fields as a query in the body of the request.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.
  7. Click Save Auth to save the authorization settings and close the New Authorization Mechanism dialog.

Testing

After you save the authentication, if you have defined an Authorization Check URL for your new authorization type, you can test your authorization definition on the Authentication tab when you click Test Authorization before continuing to develop the remaining steps of your task.

After you click Test Authorization, the Test Authorization window is displayed and populated with the URL you specified in the Authorization Check URL section, as shown in the following illustration.

To configure the Test Authorization – API Key

  1. In the Auth Check URL field, verify or enter the URL to test the authentication configuration.
  2. If your VA uses subdomains, the Tenancy field is displayed and you must specify the tenant.
  3. Enter the API key for the application in the API Key field.
  4. Select the content type expected for the URL in the Content-Type field.
  5. For testing the URL, the Method field is read-only and set to GET.
  6. Click Test to begin the authorization test.

When the authentication validation is complete, the Test Authorization dialog is closed and the results of the validation, either success or failure, are 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 – Authorization using API Key

We have seen how an Alert task can be set up in the Kore.ai XO Platform here. In this section, we will see how to configure API authorization.

API Key Setup Overview

An API key can act as both a unique identifier and a secret token for identification as well as authentication to provide a set of access rights on the associated API. Instead of prompting the end-user for both a username and password for access, the user is prompted only for an API key when configuring the task. To use the API Key Authorization Type, you must first register an account with the web application you want to work with, and then generate an API Key for that application

To authorize an API key,

  1. Go to Alert Tasks and create or select the task you want to work with. 
  2. Under API Request, expand Authorization.
  3. Select the Authorization PRovider. If none is available, create it by clicking on Create New.
  4. Ensure that your selected Authorization Type is API Key. Below is an illustration of the fields that you will need to provide information for in order to authorize the API.
  5. Name your API to get started, then let us go through these fields in detail.

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, where [tenant] including the braces represents the tenant name.

Form Fields

If the default username and password fields do not meet your needs, you can add new fields displayed to the end-user by adding authorization form fields,  for example, if a PIN code is required in the authentication process, in addition to the Username and Password form fields.

To add fields on the authorization form,Click + Add Form Field. 

The following illustration is an example of a definition to add a password field to the authorization dialog.

 

The following table describes the fields used to define an authorization IDP form field.

FIELD NAME

DESCRIPTION

Title of Field

Specify the name of the field displayed to the end-user in the authentication dialog.

Field Key

The value represents the end-user input value to the authenticating service.

Help Hint

The help text displayed in the field to describe what should be entered into the field.

Field Type

When Advanced Options is selected, specify the type of field displayed in the end-user interface to collect the user input assigned as the value for the Field Key, one of:

  • Textbox
  • Password

Mandatory

When Advanced Options is selected, select if the end-user must define this field to complete authentication.

Data Type

When Advanced Options is selected, specify the type of data expected as input from the end-user, for example, String.

Visibility

When Advanced Options is selected, specify if the authentication field should be visible, hidden, or displayed as read-only.

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, social security number or PIN,

  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.
    Header – The VA expects the authorization fields as part of the header of the request.Payload – The VA expects the authorization fields as part of the content of the body of the request.Query String – The VA expects the authorization fields as a query in the body of the request.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.
  7. Click Save Auth to save the authorization settings and close the New Authorization Mechanism dialog.

Testing

After you save the authentication, if you have defined an Authorization Check URL for your new authorization type, you can test your authorization definition on the Authentication tab when you click Test Authorization before continuing to develop the remaining steps of your task.

After you click Test Authorization, the Test Authorization window is displayed and populated with the URL you specified in the Authorization Check URL section, as shown in the following illustration.

To configure the Test Authorization – API Key

  1. In the Auth Check URL field, verify or enter the URL to test the authentication configuration.
  2. If your VA uses subdomains, the Tenancy field is displayed and you must specify the tenant.
  3. Enter the API key for the application in the API Key field.
  4. Select the content type expected for the URL in the Content-Type field.
  5. For testing the URL, the Method field is read-only and set to GET.
  6. Click Test to begin the authorization test.

When the authentication validation is complete, the Test Authorization dialog is closed and the results of the validation, either success or failure, are 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