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 – SOAP API Request

Alert Task – SOAP API Request

In this article, we will see how to configure an API Request for a SOAP service, as part of an Alert Task. Learn more about Alert tasks here.

SOAP API Request Overview

For a task with the Connection Type specified as Webservice and the Connection Mode set to SOAP you need to define:

  • Authentication – If required for your alert task, you will need to define the authentication to access the API, for example, using basic authorization, OAuth, or API Key as mentioned here.
  • WSDL URL – Define the URL that contains your WSDL data. When the URL is retrieved, you can choose from a list of Available Operations based on the WSDL, and then customize the user input fields, see below for details.
  • Access Using a connector – Specify if your Bots Platform is installed on-premises and you want to user the Kore.ai Connector agent, see below for details.
  • Response Sample – Define key/value pairs that you expect to receive in the task payload. The keys that you provide are available as drop-down choices for handling the data to display to the end-user, see below for details.
  • Preview Website Link Content in Post – The website preview content displayed in the task notification message, see below for details.

Click Save to save the API request settings.

Define the WSDL URL

    1. On the API Request tab, expand the WSDL URL section
    2. To begin the request task configuration for a SOAP request, enter the URL for your SOAP WSDL in the WSDL URL field.
    3. Click Get WSDL Description. A list of available operators defined in the WSDL opens.
    4. Click Select for the SOAP request that you want to use for your task. Kore.ai will automatically populate one or more Alert Task Fields if necessary for user input.

Customize SOAP Alert Task Fields

You can customize the default input fields provided by Kore.ai after you select one or more of the Available Operations from your WSDL. To customize the default Alert Task Fields, click Edit for the Alert Task Field that you want to customize.

The Set up Alert Task Field dialog is displayed as shown in the following illustration.

To define end-user fields for a task, specify the values for the parameters in the Set up Alert Task Field dialog as described in the following table.

Field Name Description
Field Title The title of the task input field displayed in the end-user interface, for example, Country.
Help Hint The help text displayed below the task setting the title to describe the task, for example, Enter the Country Name you want the Weather for.
Field Key A read-only key that represents the end-user input value that you want to collect, for example, country.
Field Type

Specifies the type of task input field displayed in the end-user interface to collect user input for the request object to assign to the Key value. The default setting is Textbox, but can be customized to any one of the following:

  • Date – Displays the Format field where you can select the date format syntax for the end-user to define when the task is configured for their account. In the Select Date Format drop-down list, select one of the following:
    • dd-MM-YYYY – For example, 16-05-1999
    • MM-dd-YYYY – For example, 05-16-1999
    • dd-MM-YY – For example, 16-05-99
    • YYYY-MM-dd – For example, 1999-05-16
  • URL – Displays a text box for the end-user to enter a URL including field validation for a correct URL syntax. In the Placeholder field, enter the help hint displayed in the text box, for example, Enter the URL for the website here.
  • Textbox – Displays a text box for the end-user to enter text as the task input field, typically just a few words. In the Placeholder field, enter the help hint displayed in the text field, for example, Type in the name you want to embroider.
  • Password – Displays a text box for the user to enter a password for the web service.
  • Static Dropdown – Displays a drop-down list of choices to the end-user. Click Add Option to begin adding the list of items to display to the end-user with the following parameters:
    • Option Name – The name of the option displayed to the end-user.
    • Option Value – The value the represents the Option Name returned to the application.
    • Default Value – Select the default value for the option when more than one option is defined.
    • Searchable – Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.

    Click Save. To add additional items, click Add Option again. Edit or remove options in the Actions column for options.

  • Dynamic Dropdown – Displays a drop-down list dynamically populated at runtime based on the response from a URL for your Bot, for example, a list of projects for a JIRA task notification. Define the following properties for a dynamically populated dropdown.
    • Use Separate WDSL – Add the WDSL URL, then click Get WDSL Description. You can then follow the same steps mentioned below.
    • Available Operations – If you will not use a separate WDSL,you can select a pre-existing operation. To do so, click Select in the Action column.
    • Endpoint Content Type – The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, URL Encoded JSON, CCV, Text, or Twitter Encoded JSON.
    • Endpoint Method – You can choose one of the following:
      • GET – Specifies an HTTP Request GET method for the task field.
      • POST – Specifies an HTTP Request POST method for the task field.
    • Response Path – The path in the response that contains the desired drop-down list values, for example, data.
    • Option Label Key – The key for the label of the drop-down option, for example, name.
    • Option Value Key – The key for the value of the drop-down option, for example, id.
    • Searchable – Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.
  • Textarea – Displays a text area box for the end-user to enter text as the task input, typically for several sentences. In the Placeholder field, enter the help hint displayed inside the text area.
  • Type Ahead – Displays a dynamically populated drop-down list of choices to the end-user at runtime when the user enters three or more characters that match the search results based on the response from the URL defined for the task. For example, a list of projects for a JIRA task notification message. Define the following properties for a dynamically populated drop-down.
    • Use Separate WDSL – Add the WDSL URL, then click Get WDSL Description. You can then follow the same steps mentioned below. 
    • Available Operations – If you will not use a separate WDSL,you can select a pre-existing operation. To do so, click Select in the Action column.
    • Endpoint Content Type – The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, URL Encoded JSON, CCV, Text, Twitter Encoded JSON, Multipart/Form-data, or Multipart/Related.
    • Endpoint Method – One of:
      • GET – Specifies an HTTP Request GET method for the task field.
      • POST – Specifies an HTTP Request POST method for the task field.
    • Response Path – The path in the response that contains the desired drop-down list values, for example, data.
    • Label Key – The key for the label of the drop-down option, for example, name.
    • Option Value Key – The key for the value of the drop-down option, for example, id.
  • Email – Displays a text box for the end-user to input an email address. In the Placeholder field, enter the helpful hint to display to the end-user inside the text box.
  • Date & Time – Displays a text box for the end-user to input a date with time. In the Format field, enter the expected date or time format to display to the end-user in the date text box. In the Select Date Format drop-down list, select the date with time format.
  • Time Zone – Displays a drop-down list of time zones based on the operating system settings.
  • Location – Displays a text box for the end-user to enter a geographical location, for example, Orlando, FL, or 32801.
  • Nested Form – Displays end-user input fields in a nested format below the parent input field. Specify the following fields for a nested form input field:
    • Array Element Type – Select the data type of the parent input form element.
    • Add Nested Form Field – Click to add one or more nested form fields.
  • File Upload – Displays end-user control to search for, and select a file to upload. When clicked, enter the File Upload Payload Key. When the File Upload Payload Key is defined, in the File Upload Payload Field Value drop-down list, select one of the following types:
    • File Name
    • File Size
    • File Content Type
Data Type

Select one of these user input types:

  • String – Users can input any sequence of numbers, letters, or special characters.
  • Number – Users can input a number. No special characters are allowed.
  • Boolean – User can input a Boolean value of true or false.
  • Email – User can input a valid email address.
  • Object – Data from a Bot can be received as JSON objects, for example, as location details defined as:
     “location” : {
                   “lat” : 17.4374614,
                   “lng” : 78.4482878
                }
    where you can refer to the properties in a request chain or task request as location.lat, and location.lng.
  • Array – Users can pass a comma-separated list of values to the Bot. For example, in Google Calendar, multiple attendees with data can be passed as:
    “attendees”: [“user1”, “user2”, “user3”]When selected, specify the Type for the array of end-user input as one of:
    • String
    • Number
    • Boolean
    • Email
    • Array
    • Date
  • Date – Users can type a complete date or select it from a date picker.
Placeholder The text displayed below the input textbox to help the user define the field. This field is only displayed for some Field Types.
Visibility Specify if the task input field should be visible or hidden from the end-user.
The Visibility field can also be set to Custom field where data is captured from the user but not used as a query parameter or payload field. For example, with a JIRA bot, posting a comment on a ticket using an @mention tag as shown below:
“@Mike, please look into this issue”
The JIRA API to Post a comment requires one query field and one payload field as:

  • Issue ID
  • Comment

With the Visibility field set to Custom, you can capture the user information for the user mentioned as @Mike using the JIRA API to fetch data to append to the comment field value, but not to use as payload field or query field.
The default Visibility field setting is Visible.

Mandatory Select if the end-user must define this setting to save the task settings configuration.
Untranspose the Key Select to disable key transposition by Kore.ai. By default, Kore.ai transposes a key/value pair, for example, "parameter":"value" is transposed by Kore.ai to "parameter:{value:"actualValue"}. When selected, keys are not transposed by Kore.ai and passed in the response as received.

Click Add & Continue to save the alert task field for the API request and create another alert task field, or click Add & Exit to save the alert task field for the API request and close the dialog.

Access Using a Connector

To get started with defining access using a connector for a task, follow these steps:

  1. On the API Request tab, expand the Access using a connector section.
  2. In the Access Using A Connector field, select Yes to enable access for Kore.ai Bots using the Kore.ai Connector agent. This option is only visible if a Kore.ai Connector agent is configured and enabled in your enterprise on-premises network. For more information, see Using the Kore.ai Connector.

Add the Response Sample

In the Response Sample section, you can enter or paste examples of the key-value pairs that you expect to receive in the task payload. When you define the response sample, the keys specified in the Response Sample section are available as drop-down choices for handling the output data.Add the Sample Response

  • On the API Request tab, Expand the Sample Response section.
  • Enter your Response Sample that contains the key-value pairs from your JSON response payload. Do one of the following:
    • To format the view of the response as a JSON structure with indentation as shown in the following illustration, click the Formatted  icon.
    • To format the view of the response in serialized compact form as shown in the following illustration, click the Unformatted  icon.

Website Preview Content

Some web services send links to preview media as part of the payload response. In this section, you can enable or disable preview links, and define the path to the links in the payload. By default, website preview links are disabled. The following illustration is an example of the Preview Website Link Content in Post section, when Yes is selected.

When enabled, define the path to the preview links in the payload in the Path to the Link(toPreview) field, if the path is not in the root of the payload. For example, in the following code example from an RSS payload, the path to the preview is… “item”: [ { “title”: “U.S. to Boost Refugee Intake by 30,000 by 2017”, “guid”: { “-isPermaLink”: “false”, “#text”: “SB12418904751422433479504581245034032986752” }, “link”: “http://www.wsj.com/articles/john-kerry-says-u-s-to-admit-30-000-more-refugees-in-next-2-years-1442768498?mod=fox_australian”, …When Preview website link content in Post is enabled, select preview objects such as:

  • Preview Title – Displays the title of the website content.
  • Preview Description – Displays the description of the website content.
  • Preview Media(Video) – Enables display of video links from the website content.
  • Preview Media(Image) – Enables display of image links from the website content.

Alert Task – SOAP API Request

In this article, we will see how to configure an API Request for a SOAP service, as part of an Alert Task. Learn more about Alert tasks here.

SOAP API Request Overview

For a task with the Connection Type specified as Webservice and the Connection Mode set to SOAP you need to define:

  • Authentication – If required for your alert task, you will need to define the authentication to access the API, for example, using basic authorization, OAuth, or API Key as mentioned here.
  • WSDL URL – Define the URL that contains your WSDL data. When the URL is retrieved, you can choose from a list of Available Operations based on the WSDL, and then customize the user input fields, see below for details.
  • Access Using a connector – Specify if your Bots Platform is installed on-premises and you want to user the Kore.ai Connector agent, see below for details.
  • Response Sample – Define key/value pairs that you expect to receive in the task payload. The keys that you provide are available as drop-down choices for handling the data to display to the end-user, see below for details.
  • Preview Website Link Content in Post – The website preview content displayed in the task notification message, see below for details.

Click Save to save the API request settings.

Define the WSDL URL

    1. On the API Request tab, expand the WSDL URL section
    2. To begin the request task configuration for a SOAP request, enter the URL for your SOAP WSDL in the WSDL URL field.
    3. Click Get WSDL Description. A list of available operators defined in the WSDL opens.
    4. Click Select for the SOAP request that you want to use for your task. Kore.ai will automatically populate one or more Alert Task Fields if necessary for user input.

Customize SOAP Alert Task Fields

You can customize the default input fields provided by Kore.ai after you select one or more of the Available Operations from your WSDL. To customize the default Alert Task Fields, click Edit for the Alert Task Field that you want to customize.

The Set up Alert Task Field dialog is displayed as shown in the following illustration.

To define end-user fields for a task, specify the values for the parameters in the Set up Alert Task Field dialog as described in the following table.

Field Name Description
Field Title The title of the task input field displayed in the end-user interface, for example, Country.
Help Hint The help text displayed below the task setting the title to describe the task, for example, Enter the Country Name you want the Weather for.
Field Key A read-only key that represents the end-user input value that you want to collect, for example, country.
Field Type

Specifies the type of task input field displayed in the end-user interface to collect user input for the request object to assign to the Key value. The default setting is Textbox, but can be customized to any one of the following:

  • Date – Displays the Format field where you can select the date format syntax for the end-user to define when the task is configured for their account. In the Select Date Format drop-down list, select one of the following:
    • dd-MM-YYYY – For example, 16-05-1999
    • MM-dd-YYYY – For example, 05-16-1999
    • dd-MM-YY – For example, 16-05-99
    • YYYY-MM-dd – For example, 1999-05-16
  • URL – Displays a text box for the end-user to enter a URL including field validation for a correct URL syntax. In the Placeholder field, enter the help hint displayed in the text box, for example, Enter the URL for the website here.
  • Textbox – Displays a text box for the end-user to enter text as the task input field, typically just a few words. In the Placeholder field, enter the help hint displayed in the text field, for example, Type in the name you want to embroider.
  • Password – Displays a text box for the user to enter a password for the web service.
  • Static Dropdown – Displays a drop-down list of choices to the end-user. Click Add Option to begin adding the list of items to display to the end-user with the following parameters:
    • Option Name – The name of the option displayed to the end-user.
    • Option Value – The value the represents the Option Name returned to the application.
    • Default Value – Select the default value for the option when more than one option is defined.
    • Searchable – Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.

    Click Save. To add additional items, click Add Option again. Edit or remove options in the Actions column for options.

  • Dynamic Dropdown – Displays a drop-down list dynamically populated at runtime based on the response from a URL for your Bot, for example, a list of projects for a JIRA task notification. Define the following properties for a dynamically populated dropdown.
    • Use Separate WDSL – Add the WDSL URL, then click Get WDSL Description. You can then follow the same steps mentioned below.
    • Available Operations – If you will not use a separate WDSL,you can select a pre-existing operation. To do so, click Select in the Action column.
    • Endpoint Content Type – The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, URL Encoded JSON, CCV, Text, or Twitter Encoded JSON.
    • Endpoint Method – You can choose one of the following:
      • GET – Specifies an HTTP Request GET method for the task field.
      • POST – Specifies an HTTP Request POST method for the task field.
    • Response Path – The path in the response that contains the desired drop-down list values, for example, data.
    • Option Label Key – The key for the label of the drop-down option, for example, name.
    • Option Value Key – The key for the value of the drop-down option, for example, id.
    • Searchable – Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.
  • Textarea – Displays a text area box for the end-user to enter text as the task input, typically for several sentences. In the Placeholder field, enter the help hint displayed inside the text area.
  • Type Ahead – Displays a dynamically populated drop-down list of choices to the end-user at runtime when the user enters three or more characters that match the search results based on the response from the URL defined for the task. For example, a list of projects for a JIRA task notification message. Define the following properties for a dynamically populated drop-down.
    • Use Separate WDSL – Add the WDSL URL, then click Get WDSL Description. You can then follow the same steps mentioned below. 
    • Available Operations – If you will not use a separate WDSL,you can select a pre-existing operation. To do so, click Select in the Action column.
    • Endpoint Content Type – The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, URL Encoded JSON, CCV, Text, Twitter Encoded JSON, Multipart/Form-data, or Multipart/Related.
    • Endpoint Method – One of:
      • GET – Specifies an HTTP Request GET method for the task field.
      • POST – Specifies an HTTP Request POST method for the task field.
    • Response Path – The path in the response that contains the desired drop-down list values, for example, data.
    • Label Key – The key for the label of the drop-down option, for example, name.
    • Option Value Key – The key for the value of the drop-down option, for example, id.
  • Email – Displays a text box for the end-user to input an email address. In the Placeholder field, enter the helpful hint to display to the end-user inside the text box.
  • Date & Time – Displays a text box for the end-user to input a date with time. In the Format field, enter the expected date or time format to display to the end-user in the date text box. In the Select Date Format drop-down list, select the date with time format.
  • Time Zone – Displays a drop-down list of time zones based on the operating system settings.
  • Location – Displays a text box for the end-user to enter a geographical location, for example, Orlando, FL, or 32801.
  • Nested Form – Displays end-user input fields in a nested format below the parent input field. Specify the following fields for a nested form input field:
    • Array Element Type – Select the data type of the parent input form element.
    • Add Nested Form Field – Click to add one or more nested form fields.
  • File Upload – Displays end-user control to search for, and select a file to upload. When clicked, enter the File Upload Payload Key. When the File Upload Payload Key is defined, in the File Upload Payload Field Value drop-down list, select one of the following types:
    • File Name
    • File Size
    • File Content Type
Data Type

Select one of these user input types:

  • String – Users can input any sequence of numbers, letters, or special characters.
  • Number – Users can input a number. No special characters are allowed.
  • Boolean – User can input a Boolean value of true or false.
  • Email – User can input a valid email address.
  • Object – Data from a Bot can be received as JSON objects, for example, as location details defined as:
     “location” : {
                   “lat” : 17.4374614,
                   “lng” : 78.4482878
                }
    where you can refer to the properties in a request chain or task request as location.lat, and location.lng.
  • Array – Users can pass a comma-separated list of values to the Bot. For example, in Google Calendar, multiple attendees with data can be passed as:
    “attendees”: [“user1”, “user2”, “user3”]When selected, specify the Type for the array of end-user input as one of:
    • String
    • Number
    • Boolean
    • Email
    • Array
    • Date
  • Date – Users can type a complete date or select it from a date picker.
Placeholder The text displayed below the input textbox to help the user define the field. This field is only displayed for some Field Types.
Visibility Specify if the task input field should be visible or hidden from the end-user.
The Visibility field can also be set to Custom field where data is captured from the user but not used as a query parameter or payload field. For example, with a JIRA bot, posting a comment on a ticket using an @mention tag as shown below:
“@Mike, please look into this issue”
The JIRA API to Post a comment requires one query field and one payload field as:

  • Issue ID
  • Comment

With the Visibility field set to Custom, you can capture the user information for the user mentioned as @Mike using the JIRA API to fetch data to append to the comment field value, but not to use as payload field or query field.
The default Visibility field setting is Visible.

Mandatory Select if the end-user must define this setting to save the task settings configuration.
Untranspose the Key Select to disable key transposition by Kore.ai. By default, Kore.ai transposes a key/value pair, for example, "parameter":"value" is transposed by Kore.ai to "parameter:{value:"actualValue"}. When selected, keys are not transposed by Kore.ai and passed in the response as received.

Click Add & Continue to save the alert task field for the API request and create another alert task field, or click Add & Exit to save the alert task field for the API request and close the dialog.

Access Using a Connector

To get started with defining access using a connector for a task, follow these steps:

  1. On the API Request tab, expand the Access using a connector section.
  2. In the Access Using A Connector field, select Yes to enable access for Kore.ai Bots using the Kore.ai Connector agent. This option is only visible if a Kore.ai Connector agent is configured and enabled in your enterprise on-premises network. For more information, see Using the Kore.ai Connector.

Add the Response Sample

In the Response Sample section, you can enter or paste examples of the key-value pairs that you expect to receive in the task payload. When you define the response sample, the keys specified in the Response Sample section are available as drop-down choices for handling the output data.Add the Sample Response

  • On the API Request tab, Expand the Sample Response section.
  • Enter your Response Sample that contains the key-value pairs from your JSON response payload. Do one of the following:
    • To format the view of the response as a JSON structure with indentation as shown in the following illustration, click the Formatted  icon.
    • To format the view of the response in serialized compact form as shown in the following illustration, click the Unformatted  icon.

Website Preview Content

Some web services send links to preview media as part of the payload response. In this section, you can enable or disable preview links, and define the path to the links in the payload. By default, website preview links are disabled. The following illustration is an example of the Preview Website Link Content in Post section, when Yes is selected.

When enabled, define the path to the preview links in the payload in the Path to the Link(toPreview) field, if the path is not in the root of the payload. For example, in the following code example from an RSS payload, the path to the preview is… “item”: [ { “title”: “U.S. to Boost Refugee Intake by 30,000 by 2017”, “guid”: { “-isPermaLink”: “false”, “#text”: “SB12418904751422433479504581245034032986752” }, “link”: “http://www.wsj.com/articles/john-kerry-says-u-s-to-admit-30-000-more-refugees-in-next-2-years-1442768498?mod=fox_australian”, …When Preview website link content in Post is enabled, select preview objects such as:

  • Preview Title – Displays the title of the website content.
  • Preview Description – Displays the description of the website content.
  • Preview Media(Video) – Enables display of video links from the website content.
  • Preview Media(Image) – Enables display of image links from the website content.
Menu