{"id":17812,"date":"2016-07-29T17:37:35","date_gmt":"2016-07-29T16:37:35","guid":{"rendered":"http:\/\/apidocs.kore.com\/?post_type=docs&#038;p=4337"},"modified":"2021-03-18T04:34:17","modified_gmt":"2021-03-18T04:34:17","slug":"create-a-report-task","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-1\/docs\/bots\/bot-builder-tool\/action-info-task\/create-a-report-task\/","title":{"rendered":"Information Tasks"},"content":{"rendered":"<section class=\"l-section wpb_row height_auto\"><div class=\"l-section-h i-cf\"><div class=\"g-cols vc_row type_default valign_top\"><div class=\"vc_col-sm-12 wpb_column vc_column_container\"><div class=\"vc_column-inner\"><div class=\"wpb_wrapper\">\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<div style=\"border: 1px solid black;background-color: #ffdd99\">Starting Release 8.0.0, Information Tasks are no longer supported. This feature will be discontinued in the upcoming releases. We recommend using the Dialog Tasks and Digital Forms to build these use-cases<\/div>\n<p><span data-mce-type=\"bookmark\" style=\"width: 0px;overflow: hidden;line-height: 0\" class=\"mce_SELRES_start\">\ufeff<\/span><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p><strong>Information tasks<\/strong> are used by <a href=\"https:\/\/blog.kore.ai\/a-complete-guide-to-chatbots\" rel=\"noopener noreferrer\" target=\"_blank\">chatbots<\/a> to look up data or pull reports for users and return easy-to-consume results or a link to the results for extended data. Users can identify the specific parameters or filters for the information delivered \u2013 such as the quantity of results \u2013 for bots to deliver information in a way that\u2019s simple for recipients to scan, process, and reuse.<\/p>\n<p>For example, let\u2019s say you have a\u00a0<em>Shopping Bot<\/em> that provides search results to an end-user plus a link to view those results in detail with a means to add those items to a shopping cart list. You can define an information task to display the results of the search with a link to view the search results in detail, and then when the link is clicked, display a web page that shows items that end-user can add to the shopping cart.<\/p>\n<p>In the following illustration, the <em>Relay Bot<\/em>\u00a0has\u00a0several tasks defined, one of which is an information task used to display the <strong><span style=\"color: #33cccc\">View Items<\/span><\/strong> link in the search results.<\/p>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYInformationTask-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-11555 size-full\" src=\"\/wp-content\/uploads\/sites\/18\/DIYInformationTask-1.png\" alt=\"Information Task\" width=\"1313\" height=\"925\" \/><\/a><\/p>\n<p>When the user clicks<span style=\"color: #33cccc\"><strong> View Items<\/strong><\/span>, an information report is displayed in a new tab with detailed product information and selectable results that can be added to a shopping cart as shown in the following illustration.<\/p>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYInformationTaskReport.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-10103\" src=\"\/wp-content\/uploads\/sites\/18\/DIYInformationTaskReport.png\" alt=\"Information Task - View Results Report\" width=\"758\" height=\"535\" \/><\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p>In Bot Builder, you can define the following report types for the bot response:<\/p>\n<ul>\n<li><a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-table-report\/\">Table Report<\/a> &#8211; The report is displayed in a table format with variable-width columns.<\/li>\n<li><a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-fixed-column-table-report\/\">Fixed-Column Table Report<\/a> &#8211;\u00a0The report is displayed in a table format with fixed-width columns.<\/li>\n<li><a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-card-layout-report\/\">Card Layout Report<\/a> &#8211; The report is displayed as a list of cards, or text boxes with variable formatted data, including images.<\/li>\n<li><a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/define-a-card-layout-with-actions-report\/\">Card Layout with Actions \u00a0Report<\/a> &#8211;\u00a0The report is displayed as a list of cards, or text boxes with variable formatted data, including images, plus an option to associate action tasks to the report, such as <em>Add to Cart<\/em>.<\/li>\n<li><a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/define-a-card-layout-with-group-by-report\/\">Card Layout with Group By Report<\/a> &#8211;\u00a0The report is displayed as a list of cards, or text boxes with variable formatted data that can be group by a parameter key, such as date, size, or location. The card report includes images, plus an option to associate action tasks to the report, such as <em>Add to Cart<\/em>.<\/li>\n<li><a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/define-a-shopping-cart-layout-with-actions-report\/\">Shopping Cart Layout with Actions<\/a> &#8211;\u00a0The report is displayed as a list of shopping cart options, or text boxes with variable formatted data, including images, plus an option to associate action tasks to the report, such as <em>Add to Cart<\/em>.<\/li>\n<li><a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-weather-info-report\/\">Weather Info Report<\/a> &#8211; The report is specifically designed to show a\u00a0serial data string of weather info by date, the day of the week, or forecast period.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h4>Other Examples:<\/h4>\n<ul>\n<li>Provide account summaries<\/li>\n<li>Show loyalty reward points<\/li>\n<li>Look up a person\u2019s information<\/li>\n<li>Get a summary view of outstanding items<\/li>\n<li>Pull a list of inventory<\/li>\n<li>Fetch team status information<\/li>\n<li>Update critical information<\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h2><span class=\"ez-toc-section\" id=\"Process\">Process<\/span><\/h2>\n<p>The steps that you need to complete to define an information\u00a0task\u00a0consists of four\u00a0basic steps.<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Step_1_General_Settings\"><strong>Step 1:<\/strong> \u00a0General Settings<\/span><\/h3>\n<p>The first step is to define how the task\u00a0is displayed to the end-user such as the task name, connection mode, descriptions, and other advanced settings for NLP ignore words, search keywords, error messages, task confirmation messages, mapping restrictions, and Kore.ai Bot Store settings.<\/p>\n<p>Follow these steps to configure the general settings for an Information task:<\/p>\n<ol>\n<li>Open the bot in which you want to create the Information Task.<\/li>\n<li>Hover over the side navigation panel of the bot, and click\u00a0<strong>Bot Tasks<\/strong>.<\/li>\n<li>On the Bot Tasks page, hover over the\u00a0<strong>Information Task<\/strong>\u00a0tab and click the plus icon.<\/li>\n<li>Enter a name for the task, which also doubles up as the display name. Bot Store uses the display name of the task. You can change the display name if needed. The <strong>Create Information Task<\/strong> dialog opens.<\/li>\n<li>Enter the following required details for the task, and then click <strong>Create &amp; Proceed<\/strong>:<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Create-task.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-14552 size-full\" src=\"\/wp-content\/uploads\/sites\/18\/Create-task.png\" alt=\"\" width=\"961\" height=\"570\" \/><\/a><\/p>\n<table>\n<thead>\n<tr>\n<th>Field Name<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Task Name<\/td>\n<td>The name of the task as displayed everywhere in the application and end-user channels.<\/td>\n<\/tr>\n<tr>\n<td>Display Name<\/td>\n<td>The name of the task as it gets displayed in the Kore.ai Bot Marketplace. It is the same as the task name unless you want to change it.<\/td>\n<\/tr>\n<tr>\n<td>Connection Type<\/td>\n<td>The connection type for Information Tasks is always web service. The web service sends data to Kore.ai when it polls using the end user credentials. This setting is read-only for information tasks.<\/td>\n<\/tr>\n<tr>\n<td>Connection Mode<\/td>\n<td>\n<p>This is the communications protocol connection type for your task as a web service. The web service sends data to Kore.ai when polled by Kore.ai using the end-user account login credentials.<\/p>\n<ul>\n<li><strong>REST<\/strong> &#8211; The task\u00a0uses a REST API connection that is protocol-independent\u00a0to exchange messages and to handle CRUD operations for web services.<\/li>\n<li><strong>SOAP<\/strong> &#8211; The task uses a SOAP API connection based on XML protocols for message exchange.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Long Description<\/td>\n<td>The long description of the information task.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n<h3><span class=\"ez-toc-section\" id=\"Advanced_Settings\">Advanced Settings<\/span><\/h3>\n<p>To configure the advanced settings for the task, expand the section and enter the relevant details.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Advanced-Settings-2.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-14554 size-large\" src=\"\/wp-content\/uploads\/sites\/18\/Advanced-Settings-2-1024x521.png\" alt=\"\" width=\"835\" height=\"425\" \/><\/a><\/p>\n<table>\n<thead>\n<tr>\n<th>Field Name<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Turn Off Confirmation Messages<\/td>\n<td>Select <strong>Yes<\/strong> to disable confirmation of the execution of a task when using NLP.<\/td>\n<\/tr>\n<tr>\n<td>Mapped Only Action Task<\/td>\n<td>Select to only display this action task to an end-user if mapped from another task in a flow. When <strong>Yes<\/strong> is selected, the information task is not visible in an end-user search for information tasks.<\/td>\n<\/tr>\n<tr>\n<td>Search Keywords<\/td>\n<td>Specify one or more search words an end-user can use to help locate this task in the Kore.ai <a href=\"https:\/\/bots.kore.ai\">Bot Store<\/a>.<\/td>\n<\/tr>\n<tr>\n<td>Task Demo Link<\/td>\n<td>Enter a <span style=\"color: #0000ff\">www.youtube.com<\/span> link to display a demo icon next to the task name in the\u00a0<a href=\"https:\/\/bots.kore.ai\">Bot Store<\/a>.<br \/>\nThe following illustration shows a bot task defined with a <strong>Task Demo Link<\/strong>.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/BotStoreTaskDemoLink.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-11557\" src=\"\/wp-content\/uploads\/sites\/18\/BotStoreTaskDemoLink.png\" alt=\"\" width=\"1228\" height=\"710\" \/><\/a><\/td>\n<\/tr>\n<tr>\n<td>Authorization is required for Accessing the WSDL File<br \/>\n(<i>Applies only to SOAP requests<\/i>)<\/td>\n<td>Select <b>Yes<\/b> to use authentication if web service authorization is required to access the WSDL for SOAP requests. When <b>Yes<\/b> is selected, the <b>Authentication<\/b> defined for the API request is used to access the WSDL. This setting is only available when the task <b>Connection Mode<\/b> is set to <b>SOAP<\/b>.<\/td>\n<\/tr>\n<tr>\n<td>Get Optional Fields<\/td>\n<td>Select <b>Yes<\/b> to require the end-user to select and then enter at least one of the available optional parameters.<\/td>\n<\/tr>\n<tr>\n<td>Ignore Words<\/td>\n<td>Enter one or more words to ignore for the task name, and then press enter after each word.<br \/>\nThe list of words to ignore is processed by the Bots Platform before interpreting the user input. This means the Bot can respond faster to user input and provide the correct task by filtering out words that\u00a0apply to many tasks but do not help to identify which task. For example, a user may input, <em>I want to get the weather forecast for today.<\/em>\u00a0To return the correct action\u00a0task to the user, the Bots Platform interpreter only needs to recognize three words, <em>weather<\/em>, <em>forecast<\/em>, and <em>today<\/em>. The rest of the words can be ignored.<br \/>\nThe Kore.ai Bots interpreter is already defined with a set of generic ignore words, so words like <em>I, you, want, get<\/em>, etc., do not need to be defined as ignore words. If your Bot uses the same words for many or all tasks, for example, your company name, you might add your company name as an ignore word.<\/td>\n<\/tr>\n<tr>\n<td>Error Messages<\/td>\n<td>Edit or add custom <strong>HTTP Status Codes<\/strong> and error messages for your Bot. For more information, see <a href=\"\/v8-1\/docs\/bots\/advanced-topics\/bot-settings\/error-messages\/\">Customizing Error Messages<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3><span class=\"ez-toc-section\" id=\"Step_2_Authentication_Settings\">Step 2: Authentication Settings<\/span><\/h3>\n<p>If required for your task, you will define the authentication, for example, basic authorization, OAuth, or API Key.<\/p>\n<p>Depending on the Bot action task, you may need to define how a user must be authenticated to initiate the action task. For example, <em>Twitter<\/em> can have an action task using web services that require an end-user to authenticate, usually with a login username and password, to allow Kore.ai to access the end-user account for data before executing the action task.<br \/>\nYou can define an Authorization profile or use an existing one. All authorization profiles, whether you create them at a task level or a bot level, can be used across all bot tasks.<\/p>\n<ol>\n<li>To get started with defining the<b> Authorization<\/b> for a task, from the<strong> API Request<\/strong>\u00a0tab, click the <strong>Expand<\/strong>\u00a0<img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-8284 size-full\" src=\"\/wp-content\/uploads\/sites\/18\/Expand-Icon.png\" width=\"20\" height=\"24\" \/> icon in the<b> Authorization<\/b> section.<\/li>\n<li>If you have previously defined authentication for this task, you can select it in the <strong>Authorization Provider<\/strong>\u00a0drop-down list.<\/li>\n<li>If your task does not require authentication, you can select <strong>None<\/strong> as the <strong>Authorization provider<\/strong>.<\/li>\n<li>To define a new authorization provider, click <strong>Create New<\/strong> to display the <strong>New Authorization Mechanism<\/strong> dialog.<\/li>\n<li>In the dialog, from the <b>Authorization<\/b><strong>\u00a0Type<\/strong> drop-down list, select the type of authorization used by your Bot. You can choose one of the following types of authorization:\n<ul>\n<li><strong>Basic Auth<\/strong> &#8211; A standard protocol to collect username and password information. Kore.ai uses SSL encryption in combination with basic authentication to help secure end-user information. Click on the below link for the configuration details.<br \/>\n<span class=\"collapseomatic \" id=\"id6ae85d219c1f5\"  tabindex=\"0\" title=\"Setting Up Authorization using Basic Auth\"    >Setting Up Authorization using Basic Auth<\/span><div id=\"target-id6ae85d219c1f5\" class=\"collapseomatic_content \">The following illustration is an example of the <strong>Basic Auth<\/strong> fields that you must define to enable basic authorization for your task.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYBasicAuthDialog-3-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16879\" src=\"\/wp-content\/uploads\/sites\/18\/DIYBasicAuthDialog-3-1.png\" alt=\"\" width=\"650\" height=\"711\" \/><\/a>To define basic authorization, select <strong>Basic Auth<\/strong> in the <strong>Authorization Type<\/strong> field. Then specify a\u00a0<strong>Name<\/strong>\u00a0for the authorization to be displayed in the Bot\u00a0builder user interface.<\/p>\n<h4>Defining Tenancy<\/h4>\n<p>If\u00a0required, in the\u00a0<strong>Subdomain<\/strong>\u00a0section, select <strong>Yes<\/strong>\u00a0if the base URL for a web application or user interface the uses a\u00a0tenant name in the URL. For example,\u00a0<span style=\"color: #0000ff\">kore<\/span> is the tenant organization for a web service using tenants as <span style=\"color: #0000ff\">www.<strong><em>kore<\/em><\/strong>.someCompany.com.<\/span><br \/>\nIn the following example configuration, the tenancy URL contains the <span style=\"color: #0000ff\">{tenant}<\/span> organization placeholder.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYTaskSubdomain-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16881\" src=\"\/wp-content\/uploads\/sites\/18\/DIYTaskSubdomain-1.png\" alt=\"\" width=\"650\" height=\"189\" \/><\/a><\/p>\n<h5><span class=\"wysiwyg-font-size-large\">Adding Form Fields<\/span><\/h5>\n<p>If the default username and password fields do not meet your needs, you can add new\u00a0fields displayed to the end-user by adding authorization form fields. To add fields\u00a0on the authorization form, click <span style=\"color: #33cccc\"><strong>+\u00a0Add\u00a0Form Field<\/strong><\/span>. The following\u00a0illustration is an example of a definition to add a password field\u00a0to the authorization dialog.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYBasicAuthDialogAddIDP-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16884\" src=\"\/wp-content\/uploads\/sites\/18\/DIYBasicAuthDialogAddIDP-1.png\" alt=\"\" width=\"650\" height=\"711\" \/><\/a><br \/>\nThe following table describes the fields used to define an authorization IDP form field.<\/p>\n<table>\n<thead>\n<tr>\n<th class=\"wysiwyg-text-align-left\" scope=\"col\">FIELD NAME<\/th>\n<th class=\"wysiwyg-text-align-left\">DESCRIPTION<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Field Title<\/td>\n<td>Specify the name of the field\u00a0displayed to the end-user in the authentication dialog.<\/td>\n<\/tr>\n<tr>\n<td>Field Key<\/td>\n<td>The value represents the end-user input value to the authenticating service.<\/td>\n<\/tr>\n<tr>\n<td>Help Hint<\/td>\n<td>The help text displayed in the field to describe what should be entered into the field.<\/td>\n<\/tr>\n<tr>\n<td>Field Type<\/td>\n<td>\n<p>When <strong>Advanced Options<\/strong> is selected, specify the type of field displayed in the end-user interface to collect the user input assigned as the value for the <strong>Field Key<\/strong>, one of:<\/p>\n<ul>\n<li><strong>Textbox<\/strong><\/li>\n<li><strong>Password<\/strong><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Mandatory<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, select if the end-user must define this field to complete authentication.<\/td>\n<\/tr>\n<tr>\n<td>Data Type<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, specify the type of data expected as input from the end-user, for example, <strong>String<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>Visibility<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, specify if the authentication field should be visible, hidden, or displayed as read-only.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h5><span class=\"wysiwyg-font-size-large\">Adding Authorization Fields<\/span><\/h5>\n<p>By default, authorization fields are configured as part of the header of the task\u00a0request message. If your task\u00a0request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click <span style=\"color: #33cccc\"><strong>+ Add\u00a0Authorization Field<\/strong><\/span>\u00a0and then define the fields as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16883\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\" alt=\"\" width=\"650\" height=\"272\" \/><\/a><br \/>\nIn the <strong>Field Type<\/strong> field, you can select one of the following depending on where in the task\u00a0request message and the type of authorization fields that are required.<\/p>\n<ul>\n<li><strong>Header<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as part of the header\u00a0of the request.<\/li>\n<li><strong>Payload<\/strong> &#8211; The Bot\u00a0expects the authorization fields as part of the content of the body of the request.<\/li>\n<li><strong>Query String<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as a query in the body\u00a0of the request.<\/li>\n<li><strong>Path Param<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as part of the URL path for the\u00a0request.<\/li>\n<\/ul>\n<p>In the <strong>Field Key<\/strong> field, enter the name of the field for the selected <strong>Field Type<\/strong>.<br \/>\nIn the <strong>Field Value<\/strong> field,\u00a0enter the value for the <strong>Field Key<\/strong> specified.<br \/>\nClick <b>Done<\/b>. The new authorization field is added in the <strong>Authorization Fields<\/strong> section.<br \/>\nTo add additional authorization fields, click <strong>Add<\/strong>\u00a0in the <strong>Authorization\u00a0Fields<\/strong> section.<br \/>\nIn the <strong>Authorization Check URL<\/strong> field, optionally define a URL that can be used to test the authentication settings from Bot\u00a0Builder before you deploy the task\u00a0with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL, for example,<br \/>\n<span style=\"color: #0000ff\">https:\/\/kore.someCompany.com\/sap\/opu\/odata\/sap\/{{authfield1}}\/?$format=json<\/span><br \/>\nIn the <strong>Access Using a Connector<\/strong> section, select <strong>Yes<\/strong> to enable access for Kore.ai Bots using the Kore.ai Connector agent. If your domain does not have any active Kore.ai Connectors defined, a warning message is displayed to contact the Bots Admin Console system administrator. For more information, see <a href=\"\/v8-1\/docs\/bots\/admin-console\/security-control\/security-module-overview\/#Why_Use_the_Koreai_Connector_for_Bots\">Using the Kore.ai Connector<\/a>\u00a0in the Bots Admin Console documentation.<br \/>\nClick <strong>Save<\/strong>\u00a0to save the authorization settings and close the <strong>New Authorization Mechanism<\/strong> dialog.<\/p>\n<h4><span class=\"wysiwyg-font-size-large\">Testing the Authorization &#8211; Basic Auth<\/span><\/h4>\n<p>After you save the authentication, if you defined an <strong>Authorization Check URL<\/strong> for your new authorization type, you can test your authorization definition on the <strong>Authorization <\/strong>tab when you click <strong>Test Authorization<\/strong> before continuing to develop the remaining steps of your task.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9864\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\" alt=\"Test Authorization\" width=\"976\" height=\"187\" \/><\/a><br \/>\nWhen you\u00a0click <strong>Test Authorization<\/strong>, the <strong>Test Authorization<\/strong> dialog is displayed and populated with the URL you specified in the\u00a0<strong>Authorization Check URL<\/strong> section, as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYBasicAuthDialogTestAuthorizationDialog-5-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16886\" src=\"\/wp-content\/uploads\/sites\/18\/DIYBasicAuthDialogTestAuthorizationDialog-5-1.png\" alt=\"\" width=\"500\" height=\"765\" \/><\/a><br \/>\n<strong>To configure the Test Authorization &#8211; Basic Auth<\/strong><\/p>\n<ol>\n<li>In the <strong>Auth Check URL<\/strong> field, verify or enter the URL to test the authentication configuration.<\/li>\n<li>If your bot uses subdomains, the <strong>Tenancy<\/strong> field is displayed and you must specify the tenant.<\/li>\n<li>Enter your <strong>User Name<\/strong> and <strong>Password<\/strong> for the web service.<\/li>\n<li>Select the content type expected for the URL in the <strong>Content-Type<\/strong> field.<\/li>\n<li>For testing the URL, the <strong>Method<\/strong>\u00a0field is read-only and set to <strong>GET<\/strong>.<\/li>\n<li>Click <strong>Test<\/strong> to begin the authorization test.<\/li>\n<\/ol>\n<p>When the validation of authentication is complete, the <strong>Test Authorization<\/strong> dialog is closed and the results of the validation, either success or failure, is displayed to the immediate right of the <strong>Test Authorization<\/strong> button as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestSuccess.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9857\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestSuccess.png\" alt=\"Test Authentication - Success\" width=\"967\" height=\"255\" \/><\/a><br \/>\nIf the authorization fails, the <em>Auth Test Failed<\/em> message is displayed along with the <strong>Headers<\/strong> and <strong>Response<\/strong> tabs as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9858\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\" alt=\"Authentication Test Fail\" width=\"578\" height=\"409\" \/><\/a><\/p>\n<h4><span class=\"wysiwyg-font-size-large\">How it all Works &#8211; Basic Auth<\/span><\/h4>\n<p>When basic authorization is used for a task, the Kore.ai application automatically prompts the user for log in credentials to access the web application or web service as shown in the following illustration.<br \/>\n<img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-2218 size-full\" src=\"\/wp-content\/uploads\/sites\/18\/DIYBasicAuthRequest-1.png\" alt=\"DIYBasicAuthRequest\" width=\"1130\" height=\"556\" \/><br \/>\nAfter the end-user is authorized, the settings are saved using the following naming syntax:<\/p>\n<pre class=\"\">{{ First Name }} {{ Last Name }} {{ Bot Name }} {{ Account # }} {{ Sequence # }}<\/pre>\n<p>For example, <span style=\"color: #0000ff\">John Smith&#8217;s Twitter Account #1<\/span>.<br \/>\nThe Kore.ai application can access the web application or web service for all future task\u00a0requests using this account. In addition, the end-user can reuse the account for other tasks for\u00a0the same Bot.<br \/>\n<\/div><\/li>\n<li><strong>OAuth v2 password grant type<\/strong> &#8211; Define a custom authorization type for non-standard web service authorization types. Click on the link below for the configuration details.<br \/>\n<span class=\"collapseomatic \" id=\"id6ae85d219c22e\"  tabindex=\"0\" title=\"Setting Up Authorization using oAuth v2 password grant\"    >Setting Up Authorization using oAuth v2 password grant<\/span><div id=\"target-id6ae85d219c22e\" class=\"collapseomatic_content \"><br \/>\nThe following illustration is an example of the <strong>oAuth v2 password grant<\/strong>\u00a0authorization type fields that you must define to enable a customized authorization for your task.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYoAuthv2PasswordDialog.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-8671\" src=\"\/wp-content\/uploads\/sites\/18\/DIYoAuthv2PasswordDialog.png\" alt=\"New Authorization Mechanism Dialog - oAuth v2 password grant\" width=\"449\" height=\"967\" \/><\/a>To define a custom authorization, select <strong>oAuth v2 password grant<\/strong>\u00a0in the <strong>Authorization Type<\/strong> field.\u00a0Then specify a\u00a0<strong>Name<\/strong>\u00a0for the authorization to be displayed in the Bot\u00a0builder user interface.<\/p>\n<h4>Defining Tenancy<\/h4>\n<p>If\u00a0required, in the\u00a0<strong>Subdomain<\/strong>\u00a0section, select <strong>Yes<\/strong>\u00a0if the base URL for a web application or user interface the uses a\u00a0tenant name in the URL. For example,\u00a0<span style=\"color: #0000ff\">kore<\/span> is the tenant organization for a web service using tenants as <span style=\"color: #0000ff\">www.<strong><em>kore<\/em><\/strong>.someCompany.com.<\/span><br \/>\nIn the following example configuration, the tenancy URL contains the <span style=\"color: #0000ff\">{tenant}<\/span> organization placeholder.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYTaskSubdomain-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16881\" src=\"\/wp-content\/uploads\/sites\/18\/DIYTaskSubdomain-1.png\" alt=\"\" width=\"650\" height=\"189\" \/><\/a><\/p>\n<h5><span class=\"wysiwyg-font-size-large\">Adding Form Fields<\/span><\/h5>\n<p>If the default username and password fields do not meet your needs, you can add new\u00a0fields displayed to the end-user by adding authorization form fields. To add fields\u00a0on the authorization form, click <span style=\"color: #33cccc\"><strong>+\u00a0Add\u00a0Form Field<\/strong><\/span>. The following\u00a0illustration is an example of a definition to add a password field\u00a0to the authorization dialog.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYBasicAuthDialogAddIDP-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16884\" src=\"\/wp-content\/uploads\/sites\/18\/DIYBasicAuthDialogAddIDP-1.png\" alt=\"\" width=\"650\" height=\"711\" \/><\/a><br \/>\nThe following table describes the fields used to define an authorization IDP form field.<\/p>\n<table>\n<thead>\n<tr>\n<th class=\"wysiwyg-text-align-left\" scope=\"col\">FIELD NAME<\/th>\n<th class=\"wysiwyg-text-align-left\">DESCRIPTION<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Field Title<\/td>\n<td>Specify the name of the field\u00a0displayed to the end-user in the authentication dialog.<\/td>\n<\/tr>\n<tr>\n<td>Field Key<\/td>\n<td>The value represents the end-user input value to the authenticating service.<\/td>\n<\/tr>\n<tr>\n<td>Help Hint<\/td>\n<td>The help text displayed in the field to describe what should be entered into the field.<\/td>\n<\/tr>\n<tr>\n<td>Field Type<\/td>\n<td>\n<p>When <strong>Advanced Options<\/strong> is selected, specify the type of field displayed in the end-user interface to collect the user input assigned as the value for the <strong>Field Key<\/strong>, one of:<\/p>\n<ul>\n<li><strong>Textbox<\/strong><\/li>\n<li><strong>Password<\/strong><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Mandatory<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, select if the end-user must define this field to complete authentication.<\/td>\n<\/tr>\n<tr>\n<td>Data Type<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, specify the type of data expected as input from the end-user, for example, <strong>String<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>Visibility<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, specify if the authentication field should be visible, hidden, or displayed as read-only.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h5><span class=\"wysiwyg-font-size-large\">Adding Authorization Fields<\/span><\/h5>\n<p>By default, authorization fields are configured as part of the header of the task\u00a0request message. If your task\u00a0request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click <span style=\"color: #33cccc\"><strong>+ Add\u00a0Authorization Field<\/strong><\/span>\u00a0and then define the fields as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16883\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\" alt=\"\" width=\"650\" height=\"272\" \/><\/a><br \/>\nIn the <strong>Field Type<\/strong> field, you can select one of the following depending on where in the task\u00a0request message and the type of authorization fields that are required.<\/p>\n<ul>\n<li><strong>Header<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as part of the header\u00a0of the request.<\/li>\n<li><strong>Payload<\/strong> &#8211; The Bot\u00a0expects the authorization fields as part of the content of the body of the request.<\/li>\n<li><strong>Query String<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as a query in the body\u00a0of the request.<\/li>\n<li><strong>Path Param<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as part of the URL path for the\u00a0request.<\/li>\n<\/ul>\n<p>In the <strong>Field Key<\/strong> field, enter the name of the field for the selected <strong>Field Type<\/strong>.<br \/>\nIn the <strong>Field Value<\/strong> field,\u00a0enter the value for the <strong>Field Key<\/strong> specified.<br \/>\nClick <b>Done<\/b>. The new authorization field is added in the <strong>Authorization Fields<\/strong> section.<br \/>\nTo add additional authorization fields, click <strong>Add<\/strong>\u00a0in the <strong>Authorization\u00a0Fields<\/strong> section.<\/p>\n<h5>Defining the Token URL<\/h5>\n<p>In the <strong>Token\u00a0URL<\/strong> field, optionally define a URL that can be used to test the authentication settings from Bot\u00a0Builder before you deploy the task\u00a0with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL, for example,<br \/>\n<span style=\"color: #0000ff\">http:\/\/{tenant}.someCompany.com\/test\/{{tokenId}}<\/span><br \/>\nIn the <strong>Token URL Method<\/strong> field, select the HTTP request method type for the <strong>Token URL<\/strong>. One of <strong>PUT<\/strong>, <strong>POST<\/strong>, <strong>PATCH<\/strong>, <strong>DELETE<\/strong>, and <strong>GET<\/strong>.<br \/>\nIn the <strong>Token URL Content Type<\/strong> field,\u00a0select the content type expected from the <strong>Token\u00a0URL<\/strong>. One of: <strong>JSON, RSS, XML, URL Encoded JSON, CSV, Text, Twitter Encoded JSON, Multipart\/Form-data,Multipart\/Related<\/strong>, or <strong>Oracle ADF<\/strong>.<br \/>\nIn the <strong>Access Using a Connector<\/strong> section, select <strong>Yes<\/strong> to enable access for Kore.ai Bots using the Kore.ai Connector agent. If your domain does not have any active Kore.ai Connectors defined, a warning message is displayed to contact the Bots Admin Console system administrator. For more information, see <a href=\"\/v8-1\/docs\/bots\/admin-console\/security-control\/security-module-overview\/#Why_Use_the_Koreai_Connector_for_Bots\">Using the Kore.ai Connector<\/a>\u00a0in the Bots Admin Console documentation.<br \/>\nClick <strong>Save Auth<\/strong>\u00a0to save the authorization settings and close the <strong>New Authorization Mechanism<\/strong> dialog.<\/p>\n<h5><span style=\"color: inherit\">Testing the Authorization<\/span><\/h5>\n<p>After you save the authentication, if you defined an <strong>Authorization URL<\/strong> for your new authorization type, you can test your authorization definition on the <strong>Authorization <\/strong>page when you click <strong>Test Authorization<\/strong> before continuing to develop the remain steps of your task.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9864\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\" alt=\"Test Authorization\" width=\"976\" height=\"187\" \/><\/a><br \/>\nWhen you\u00a0click <strong>Test Authorization<\/strong>, the <strong>Test Authorization<\/strong> dialog is displayed and populated with the URL you specified in the\u00a0<strong>Authorization Check URL<\/strong> section, as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuthOAuthV2PassTest.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9862\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuthOAuthV2PassTest.png\" alt=\"Test Authorization Dialog - OAuth V2 Password Grant\" width=\"590\" height=\"620\" \/><\/a><br \/>\nClick <strong>Test<\/strong> to begin the authorization test. When the validation of authentication is complete, the <strong>Test Authorization<\/strong> dialog is closed and the results of the validation, either success or failure, is displayed to the immediate right of the <strong>Test Authorization<\/strong> button. If the authorization fails, the <em>Auth Test Failed<\/em> message is displayed along with the <strong>Headers<\/strong> and <strong>Response<\/strong> tabs as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9858\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\" alt=\"Authentication Test Fail\" width=\"578\" height=\"409\" \/><\/a><br \/>\n<\/div><\/li>\n<li><strong>OAuth v2 client credential<\/strong> &#8211;<\/li>\n<li><strong>OAuth v1<\/strong> &#8211; Enables web applications or web services to access protected resources using an API without end-users having to disclose their log on credentials to Kore.ai. Click on the link below for the configuration details.<br \/>\n<span class=\"collapseomatic \" id=\"id6ae85d219c24d\"  tabindex=\"0\" title=\"Setting Up Authorization using OAuth v1\"    >Setting Up Authorization using OAuth v1<\/span><div id=\"target-id6ae85d219c24d\" class=\"collapseomatic_content \"><br \/>\nOAuth is an open protocol to allow secure authorization in a simple and standard method from web, mobile, and desktop applications.To use OAuth, 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.<\/p>\n<h5><span class=\"wysiwyg-font-size-large\">How OAuth v1 Works<\/span><\/h5>\n<ol>\n<li>The Kore.ai application obtains an unauthorized request token from the web application. The Kore.ai\u00a0application redirects the user to a login dialog at the web application.<\/li>\n<li>The user authorizes the request token, associating it with their account. The web application\u00a0redirects the user back to the Kore.ai application.<\/li>\n<li>The Kore.ai application\u00a0exchanges the request token for an access token.<\/li>\n<li>The access token allows the Kore.ai application\u00a0to access a protected resource at the provider, on behalf of the user.<\/li>\n<\/ol>\n<p>The following illustration is an example of the <strong>oAuth v1 <\/strong>authorization type fields that you must define to enable a customized authorization for your task.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYOAUTHV1-3.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-8675 size-full\" src=\"\/wp-content\/uploads\/sites\/18\/DIYOAUTHV1-3.png\" alt=\"New Authorization Mechanism - oAuth V1\" width=\"448\" height=\"981\" \/><\/a><br \/>\nTo define oAuth v1, define the fields described in the following table.<\/p>\n<table width=\"474\">\n<thead>\n<tr>\n<th class=\"wysiwyg-text-align-left\">FIELD NAME<\/th>\n<th class=\"wysiwyg-text-align-left\">DESCRIPTION<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Authorization Type<\/td>\n<td>Set to oAuth v1.<\/td>\n<\/tr>\n<tr>\n<td>Callback URL<\/td>\n<td>The URL used by the web application or web service to redirect the end-user after end-user authorization is complete. This value, <span style=\"color: #0000ff\">https:\/\/idp.kore.ai\/workflows\/callback\/<\/span>, \u00a0is provided as a read-only value by the Kore.ai application when you define oAuth v1 settings.<\/td>\n<\/tr>\n<tr>\n<td>Identity Provider Name<\/td>\n<td>The name of the web application or web service, for example, <em>Twitter<\/em>. This field is required.<\/td>\n<\/tr>\n<tr>\n<td>Consumer Key<\/td>\n<td>The value provided as the Kore.ai application\u00a0identification to the web application.\u00a0This field is required.<\/td>\n<\/tr>\n<tr>\n<td>Consumer Secret<\/td>\n<td>The secret value\u00a0provided by the Kore.ai application\u00a0to establish ownership of the <strong>Consumer Key<\/strong>.\u00a0This field is required.<\/td>\n<\/tr>\n<tr>\n<td>Request Token Link<\/td>\n<td>The URL used by the Kore.ai application to obtain an unauthorized request token. A request token is the\u00a0value used by the Kore.ai application\u00a0to obtain authorization from the end-user to obtain an access token. For example, <span style=\"color: #0000ff\">https:\/\/{tenant}.someCompany.com\/oauth\/request_token<\/span>. After end-user authorization, an access token can be requested by the Kore.ai application.\u00a0This field is required.<\/td>\n<\/tr>\n<tr>\n<td>Access Token Link<\/td>\n<td>The URL used to exchange the end-user\u00a0authorized request token for an access token. The access token is the\u00a0value used by the Kore.ai application\u00a0to gain access to the web application or web service\u00a0on behalf of the end-user, instead of using the end-users log on credentials. For example, <span style=\"color: #0000ff\">https:\/\/{tenant}.someCompany.com\/oauth\/access_token<\/span>. This field is required.<\/td>\n<\/tr>\n<tr>\n<td>User Authorization Link<\/td>\n<td>The URL used to obtain end-user\u00a0authorization for the Kore.ai application to access the web application or web service using the access token. For example, <span style=\"color: #0000ff\">https:\/\/{tenant}.someCompany.com\/oauth\/authorize<\/span>. This field is required.<\/td>\n<\/tr>\n<tr>\n<td>Access Using a Connector<\/td>\n<td>Select <strong>Yes<\/strong> 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 <a href=\"\/v8-1\/docs\/bots\/admin-console\/security-control\/security-module-overview\/#Why_Use_the_Koreai_Connector_for_Bots\">Using the Kore.ai Connector<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4>Defining Tenancy<\/h4>\n<p>If\u00a0required, in the\u00a0<strong>Subdomain<\/strong>\u00a0section, select <strong>Yes<\/strong>\u00a0if the base URL for a web application or user interface the uses a\u00a0tenant name in the URL. For example,\u00a0<span style=\"color: #0000ff\">kore<\/span> is the tenant organization for a web service using tenants as <span style=\"color: #0000ff\">www.<strong><em>kore<\/em><\/strong>.someCompany.com.<\/span><br \/>\nIn the following example configuration, the tenancy URL contains the <span style=\"color: #0000ff\">{tenant}<\/span> organization placeholder.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYTaskSubdomain-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-17135\" src=\"\/wp-content\/uploads\/sites\/18\/DIYTaskSubdomain-1.png\" alt=\"\" width=\"650\" height=\"189\" \/><\/a><\/p>\n<h4>Adding Additional Fields<\/h4>\n<p>Click <span style=\"color: #33cccc\"><strong>+\u00a0Add\u00a0Additional Fields<\/strong><\/span> to open the <strong>Additional Fields<\/strong> dialog, and then enter one or more key\/value pairs that represent additional authorization input fields if required as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuthOAuthV1AddFields.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9863\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuthOAuthV1AddFields.png\" alt=\"Additional Authorization Fields\" width=\"501\" height=\"346\" \/><\/a><br \/>\nSpecify the following fields:<\/p>\n<ul>\n<li><strong>Field Key<\/strong> &#8211; The\u00a0name of the custom field to specify\u00a0for authorization.<\/li>\n<li><strong>Field Value<\/strong> &#8211; The value of the custom field to specify for the authorization.<\/li>\n<\/ul>\n<p>Click <strong>Add<\/strong> to save the <strong>Additional Field<\/strong>.<br \/>\nTo add more <strong>Additional Fields<\/strong>, click <strong>Add<\/strong>\u00a0in the <strong>Additional Fields<\/strong> section.<\/p>\n<h4><span class=\"wysiwyg-font-size-large\">Adding Authorization Fields<\/span><\/h4>\n<p>By default, authorization fields are configured as part of the header of the task\u00a0request message. If your task\u00a0request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click <span style=\"color: #33cccc\"><strong>+ Add\u00a0Authorization Field<\/strong><\/span>\u00a0and then define the fields as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9855\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\" alt=\"Authorization Fields for Basic Auth\" width=\"488\" height=\"350\" \/><\/a><br \/>\nIn the <strong>Field Type<\/strong> field, you can select one of the following depending on where in the task\u00a0request message and the type of authorization fields that are required.<\/p>\n<ul>\n<li><strong>Header<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as part of the header\u00a0of the request.<\/li>\n<li><strong>Payload<\/strong> &#8211; The Bot\u00a0expects the authorization fields as part of the content of the body of the request.<\/li>\n<li><strong>Query String<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as a query in the body\u00a0of the request.<\/li>\n<li><strong>Path Param<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as part of the URL path for the\u00a0request.<\/li>\n<\/ul>\n<p>In the <strong>Field Key<\/strong> field, enter the name of the field for the selected <strong>Field Type<\/strong>.<br \/>\nIn the <strong>Field Value<\/strong> field,\u00a0enter the value for the <strong>Field Key<\/strong> specified.<br \/>\nClick <strong>Add<\/strong>. The new authorization field is added in the <strong>Authorization Fields<\/strong> section.<br \/>\nTo add additional authorization fields, click <strong>Add<\/strong>\u00a0in the <strong>Authorization\u00a0Fields<\/strong> section.<\/p>\n<h4><span style=\"color: inherit\">Testing the Authorization<\/span><\/h4>\n<p>After you save the authorization, you can test your authorization definition on the <strong>Authorization<\/strong> page when you click <strong>Test Authorization<\/strong> before continuing to develop the remain steps of your task.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9864\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\" alt=\"Test Authorization\" width=\"976\" height=\"187\" \/><\/a><br \/>\nWhen you\u00a0click <strong>Test Authorization<\/strong>, the test is executed using the authentication token URLs and the <strong>Consumer Key<\/strong> and <strong>Consumer Token<\/strong>. If the tenancy was defined, the <strong>Test Authorization<\/strong> dialog is displayed\u00a0as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYTestAuthorizationDialogoAuth.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-8681 size-full\" src=\"\/wp-content\/uploads\/sites\/18\/DIYTestAuthorizationDialogoAuth.png\" alt=\"Test Authorization Dialog - oAuth\" width=\"594\" height=\"295\" \/><\/a><br \/>\nClick <strong>Test<\/strong>\u00a0to begin the authorization test.\u00a0When the validation of authentication is complete, the <strong>Test Authorization<\/strong> dialog is closed and the results of the validation, either success or failure, is displayed to the immediate right of the <strong>Test Authorization<\/strong> button. If the authorization fails, the <em>Auth Test Failed<\/em> message is displayed along with the <strong>Headers<\/strong> and <strong>Response<\/strong> tabs as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9858\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\" alt=\"Authentication Test Fail\" width=\"578\" height=\"409\" \/><\/a><br \/>\n<\/div><\/li>\n<li><strong>OAuth v2<\/strong> &#8211; The newest version of OAuth protocol focusing on specific authorization flows for web applications and web services. Click on the link below for the configuration details.<br \/>\n<span class=\"collapseomatic \" id=\"id6ae85d219c268\"  tabindex=\"0\" title=\"Setting Up Authorization using OAuth v2\"    >Setting Up Authorization using OAuth v2<\/span><div id=\"target-id6ae85d219c268\" class=\"collapseomatic_content \"><br \/>\nOAuth v2 is the new version of the\u00a0open 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.<\/p>\n<h4><span class=\"wysiwyg-font-size-large\">How oAuth v2 Works<\/span><\/h4>\n<ol>\n<li>The Kore.ai application redirects the user to a login dialog at the web application.<\/li>\n<li>The user authenticates.<\/li>\n<li>The web application\u00a0redirects the user back to the Kore.ai application with an access token.<\/li>\n<li>The Kore.ai application validates the\u00a0access token.<\/li>\n<li>The access token allows the Kore.ai application\u00a0to access a protected resource at the provider, on behalf of the user.<\/li>\n<\/ol>\n<p>The following illustration shows the fields to define for the oAuth v2\u00a0<strong>Authorization Type<\/strong>.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYAuthorizationOAUTHV2Dialog.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-8680\" src=\"\/wp-content\/uploads\/sites\/18\/DIYAuthorizationOAUTHV2Dialog.png\" alt=\"oAuth v2 Dialog\" width=\"449\" height=\"984\" \/><\/a><br \/>\nTo configure oAuth v2, define the fields described in the following table.<\/p>\n<table width=\"100%\">\n<thead>\n<tr>\n<th class=\"wysiwyg-text-align-left\">FIELD NAME<\/th>\n<th class=\"wysiwyg-text-align-left\">DESCRIPTION<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Authorization Type<\/td>\n<td>Set to oAuth v2.<\/td>\n<\/tr>\n<tr>\n<td>Callback URL<\/td>\n<td>The URL used by the web application or web service to redirect the end-user after end-user authorization is complete. This value, <span style=\"color: #0000ff\">https:\/\/idp.kore.ai\/workflows\/callback\/<\/span>\u00a0is provided as a read-only value by the Kore.ai application when you define oAuth v2 settings.<\/td>\n<\/tr>\n<tr>\n<td>Identity Provider Name<\/td>\n<td>The name of the web application or web service, for example, <em>Asana<\/em>. This field is required.<\/td>\n<\/tr>\n<tr>\n<td>Client ID<\/td>\n<td>The ID of the Kore.ai client.<\/td>\n<\/tr>\n<tr>\n<td>Client Secret Key<\/td>\n<td>The value provided as the Kore.ai application authentication based on the Client ID\u00a0to the web application.<\/td>\n<\/tr>\n<tr>\n<td>Authorization\u00a0URL<\/td>\n<td>The URL used to obtain end-user\u00a0authorization for the Kore.ai application to access the web application or web service using the access token.\u00a0This field is required.<\/td>\n<\/tr>\n<tr>\n<td>Access Using a Connector<\/td>\n<td>Select <strong>Yes<\/strong> 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 <a href=\"\/v8-1\/docs\/bots\/admin-console\/security-control\/security-module-overview\/#Why_Use_the_Koreai_Connector_for_Bots\">Using the Kore.ai Connector<\/a>.<\/td>\n<\/tr>\n<tr>\n<td>Authorization URL<\/td>\n<td>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.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4>Defining Tenancy<\/h4>\n<p>If\u00a0required, in the\u00a0<strong>Subdomain<\/strong>\u00a0section, select <strong>Yes<\/strong>\u00a0if the base URL for a web application or user interface the uses a\u00a0tenant name in the URL. For example,\u00a0<span style=\"color: #0000ff\">kore<\/span> is the tenant organization for a web service using tenants as <span style=\"color: #0000ff\">www.<strong><em>kore<\/em><\/strong>.someCompany.com.<\/span><br \/>\nIn the following example configuration, the tenancy URL contains the <span style=\"color: #0000ff\">{tenant}<\/span> organization placeholder.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYTaskSubdomain-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-8661\" src=\"\/wp-content\/uploads\/sites\/18\/DIYTaskSubdomain-1.png\" alt=\"Task Subdomain Section\" width=\"588\" height=\"174\" \/><\/a><\/p>\n<h4>Adding Additional Fields<\/h4>\n<p>Click <span style=\"color: #33cccc\"><strong>+\u00a0Add\u00a0Additional Fields<\/strong><\/span> to open the <strong>Additional Fields<\/strong> dialog, and then enter one or more key\/value pairs that represent additional authorization input fields if required as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuthOAuthV1AddFields.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9863\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuthOAuthV1AddFields.png\" alt=\"Additional Authorization Fields\" width=\"501\" height=\"346\" \/><\/a><br \/>\nSpecify the following fields:<\/p>\n<ul>\n<li><strong>Field Key<\/strong> &#8211; The\u00a0name of the custom field to specify\u00a0for authorization.<\/li>\n<li><strong>Value<\/strong> &#8211; The value of the custom field to specify for the authorization.<\/li>\n<\/ul>\n<p>Click <strong>Add<\/strong> to save the <strong>Additional Field<\/strong>.<br \/>\nTo add more <strong>Additional Fields<\/strong>, click <strong>Add<\/strong>\u00a0in the <strong>Additional Fields<\/strong> section.<\/p>\n<h4><span class=\"wysiwyg-font-size-large\">Adding Authorization Fields<\/span><\/h4>\n<p>By default, authorization fields are configured as part of the header of the task\u00a0request message. If your task\u00a0request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click <span style=\"color: #33cccc\"><strong>+ Add\u00a0Authorization Field<\/strong><\/span>\u00a0and then define the fields as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9855\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\" alt=\"Authorization Fields for Basic Auth\" width=\"488\" height=\"350\" \/><\/a><br \/>\nIn the <strong>Field Type<\/strong> field, you can select one of the following depending on where in the task\u00a0request message and the type of authorization fields that are required.<\/p>\n<ul>\n<li><strong>Header<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as part of the header\u00a0of the request.<\/li>\n<li><strong>Payload<\/strong> &#8211; The Bot\u00a0expects the authorization fields as part of the content of the body of the request.<\/li>\n<li><strong>Query String<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as a query in the body\u00a0of the request.<\/li>\n<li><strong>Path Param<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as part of the URL path for the\u00a0request.<\/li>\n<\/ul>\n<p>In the <strong>Field Key<\/strong> field, enter the name of the field for the selected <strong>Field Type<\/strong>.<br \/>\nIn the <strong>Field Value<\/strong> field,\u00a0enter the value for the <strong>Field Key<\/strong> specified.<br \/>\nClick <strong>Add<\/strong>. The new authorization field is added in the <strong>Authorization Fields<\/strong> section.<br \/>\nTo add additional authorization fields, click <strong>Add<\/strong>\u00a0in the <strong>Authorization\u00a0Fields<\/strong> section.<\/p>\n<h4><span style=\"color: inherit\">Testing the Authorization<\/span><\/h4>\n<p>After you save the authorization, you can test your authorization definition on the <strong>Authorization<\/strong> page when you click <strong>Test Authorization<\/strong> before continuing to develop the remain steps of your task.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9864\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\" alt=\"Test Authorization\" width=\"976\" height=\"187\" \/><\/a><br \/>\nWhen you\u00a0click <strong>Test Authorization<\/strong>, the test is executed using the authentication token URLs and the <strong>Client ID<\/strong>\u00a0and <strong>Client Secret Key<\/strong>. If the tenancy was defined, the <strong>Test Authorization<\/strong> dialog is displayed\u00a0as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYTestAuthorizationDialogoAuth.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-8681 size-full\" src=\"\/wp-content\/uploads\/sites\/18\/DIYTestAuthorizationDialogoAuth.png\" width=\"594\" height=\"295\" \/><\/a><br \/>\nClick <strong>Test<\/strong>\u00a0to begin the authorization test.\u00a0When the validation of authentication is complete, the <strong>Test Authorization<\/strong> dialog is closed and the results of the validation, either success or failure, is displayed to the immediate right of the <strong>Test Authorization<\/strong> button. If the authorization fails, the <em>Auth Test Failed<\/em> message is displayed along with the <strong>Headers<\/strong> and <strong>Response<\/strong> tabs as shown in the following illustration.<br \/>\n<\/div><\/li>\n<li><strong>API Key<\/strong> &#8211; An identification and authorization token generated or provided by a web application or web service used to identify the incoming application request, and in some cases, also provide authentication for secure access. Click on the link below for the configuration details.<br \/>\n<span class=\"collapseomatic \" id=\"id6ae85d219c282\"  tabindex=\"0\" title=\"Setting Up Authorization using an API Key\"    >Setting Up Authorization using an API Key<\/span><div id=\"target-id6ae85d219c282\" class=\"collapseomatic_content \"><br \/>\nAn\u00a0API key can act as both a unique identifier and a secret token for identification as well as authentication\u00a0to provide a\u00a0set 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 <strong>Authorization Type<\/strong>, you must first register an account with the web application and then generate an API Key for\u00a0that application to configure the settings for the Kore.ai authorization mechanism.The following illustration shows the fields to define for the API Key\u00a0<strong>Authorization Type<\/strong>.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYAPIKey-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-8682\" src=\"\/wp-content\/uploads\/sites\/18\/DIYAPIKey-1.png\" alt=\"Authorization Tab - API Key Dialog\" width=\"537\" height=\"982\" \/><\/a>To define an API key\u00a0authorization, select <strong>API Key<\/strong>\u00a0in the <strong>Authorization Type<\/strong> field. Then specify a\u00a0<strong>Name<\/strong>\u00a0for the authorization to be displayed in the Bot\u00a0builder user interface.<\/p>\n<h4>Defining Tenancy<\/h4>\n<p>If\u00a0required, in the\u00a0<strong>Subdomain<\/strong>\u00a0section, select <strong>Yes<\/strong>\u00a0if the base URL for a web application or user interface the uses a\u00a0tenant name in the URL. For example,\u00a0<span style=\"color: #0000ff\">kore<\/span> is the tenant organization for a web service using tenants as <span style=\"color: #0000ff\">www.<strong><em>kore<\/em><\/strong>.someCompany.com.<\/span><br \/>\nIn the following example configuration, the tenancy URL contains the <span style=\"color: #0000ff\">{tenant}<\/span> organization placeholder.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYTaskSubdomain-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16881\" src=\"\/wp-content\/uploads\/sites\/18\/DIYTaskSubdomain-1.png\" alt=\"\" width=\"650\" height=\"189\" \/><\/a><\/p>\n<h4><span class=\"wysiwyg-font-size-large\">Adding Form Fields to the Authorization Form<\/span><\/h4>\n<p>If the default username and password fields do not meet your needs, you can add new\u00a0fields displayed to the end-user by adding authorization form fields. To add fields\u00a0on the authorization form, click <span style=\"color: #33cccc\"><strong>+\u00a0Add\u00a0Form Field<\/strong><\/span>. The following\u00a0illustration is an example of a definition to add a password field\u00a0to the authorization dialog.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYBasicAuthDialogAddIDP-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16884\" src=\"\/wp-content\/uploads\/sites\/18\/DIYBasicAuthDialogAddIDP-1.png\" alt=\"\" width=\"650\" height=\"711\" \/><\/a><br \/>\nThe following table describes the fields used to define an authorization IDP form field.<\/p>\n<table>\n<thead>\n<tr>\n<th class=\"wysiwyg-text-align-left\" scope=\"col\">FIELD NAME<\/th>\n<th class=\"wysiwyg-text-align-left\">DESCRIPTION<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Title of Field<\/td>\n<td>Specify the name of the field\u00a0displayed to the end-user in the authentication dialog.<\/td>\n<\/tr>\n<tr>\n<td>Field Key<\/td>\n<td>The value represents the end-user input value to the authenticating service.<\/td>\n<\/tr>\n<tr>\n<td>Help Hint<\/td>\n<td>The help text displayed in the field to describe what should be entered into the field.<\/td>\n<\/tr>\n<tr>\n<td>Field Type<\/td>\n<td>\n<p>When <strong>Advanced Options<\/strong> is selected, specify the type of field displayed in the end-user interface to collect the user input assigned as the value for the <strong>Field Key<\/strong>, one of:<\/p>\n<ul>\n<li><strong>Textbox<\/strong><\/li>\n<li><strong>Password<\/strong><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Mandatory<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, select if the end-user must define this field to complete authentication.<\/td>\n<\/tr>\n<tr>\n<td>Data Type<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, specify the type of data expected as input from the end-user, for example, <strong>String<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>Visibility<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, specify if the authentication field should be visible, hidden, or displayed as read-only.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4><span class=\"wysiwyg-font-size-large\">Adding Authorization Fields<\/span><\/h4>\n<p>By default, authorization fields are configured as part of the header of the task\u00a0request message. If your task\u00a0request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click <span style=\"color: #33cccc\"><strong>+ Add\u00a0Authorization Field<\/strong><\/span>\u00a0and then define the fields as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16883\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\" alt=\"\" width=\"650\" height=\"272\" \/><\/a><br \/>\nIn the <strong>Field Type<\/strong> field, you can select one of the following depending on where in the task\u00a0request message and the type of authorization fields that are required.<\/p>\n<ul>\n<li><strong>Header<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as part of the header\u00a0of the request.<\/li>\n<li><strong>Payload<\/strong> &#8211; The Bot\u00a0expects the authorization fields as part of the content of the body of the request.<\/li>\n<li><strong>Query String<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as a query in the body\u00a0of the request.<\/li>\n<li><strong>Path Param<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as part of the URL path for the\u00a0request.<\/li>\n<\/ul>\n<p>In the <strong>Field Key<\/strong> field, enter the name of the field for the selected <strong>Field Type<\/strong>.<br \/>\nIn the <strong>Field Value<\/strong> field,\u00a0enter the value for the <strong>Field Key<\/strong> specified.<br \/>\nClick <strong>Add<\/strong>. The new authorization field is added in the <strong>Authorization Fields<\/strong> section.<br \/>\nTo add additional authorization fields, click <strong>Add<\/strong>\u00a0in the <strong>Authorization\u00a0Fields<\/strong> section.<\/p>\n<h4><span class=\"wysiwyg-font-size-large\">Testing the Authorization &#8211;\u00a0API Key<\/span><\/h4>\n<p>After you save the authentication, if you defined an <strong>Authorization Check URL<\/strong> for your new authorization type, you can test your authorization definition on the <strong>Authentication<\/strong>\u00a0tab when you click <strong>Test Authorization<\/strong> before continuing to develop the remain steps of your task.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9864\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\" alt=\"Test Authorization\" width=\"976\" height=\"187\" \/><\/a><br \/>\nWhen you\u00a0click <strong>Test Authorization<\/strong>, the <strong>Test Authorization<\/strong> dialog is displayed and populated with the URL you specified in the\u00a0<strong>Authorization Check URL<\/strong> section, as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYTestAuthorizationDialogAPIKey.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-8683\" src=\"\/wp-content\/uploads\/sites\/18\/DIYTestAuthorizationDialogAPIKey.png\" alt=\"Test Authorization - API Key\" width=\"594\" height=\"568\" \/><\/a><br \/>\n<strong>To configure the Test Authorization &#8211;\u00a0API Key<\/strong><\/p>\n<ol>\n<li>In the <strong>Auth Check URL<\/strong> field, verify or enter the URL to test the authentication configuration.<\/li>\n<li>If your bot uses subdomains, the <strong>Tenancy<\/strong> field is displayed and you must specify the tenant.<\/li>\n<li>Enter the API key for the application in the <strong>API Key<\/strong> field.<\/li>\n<li>Select the content type expected for the URL in the <strong>Content-Type<\/strong> field.<\/li>\n<li>For testing the URL, the <strong>Method<\/strong>\u00a0field is read-only and set to <strong>GET<\/strong>.<\/li>\n<li>Click <strong>Test<\/strong> to begin the authorization test.<\/li>\n<\/ol>\n<p>When the validation of authentication is complete, the <strong>Test Authorization<\/strong> dialog is closed and the results of the validation, either success or failure, is displayed to the immediate right of the <strong>Test Authorization<\/strong> button. If the authorization fails, the <em>Auth Test Failed<\/em> message is displayed along with the <strong>Headers<\/strong> and <strong>Response<\/strong> tabs as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9858\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\" alt=\"Authentication Test Fail\" width=\"578\" height=\"409\" \/><\/a><br \/>\n<\/div><\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 class=\"wysiwyg-indent2\"><span class=\"ez-toc-section\" id=\"Step_3_API_Request\"><strong>Step 3:<\/strong> \u00a0API Request<\/span><\/h3>\n<p class=\"wysiwyg-indent2\">If required for your task, you can define a request object to, for example, provide a dynamic drop-down choice for the end-user to select from to complete the task. On the information task <strong>API Request<\/strong> tab, you can define API\u00a0<strong>Parameters<\/strong>, optional API task <strong>Initializer<\/strong>, API <strong>Request<\/strong>\u00a0pre- or post-processor, and the API <strong>Request<\/strong>. You will also need to add a <strong>Response Sample<\/strong> expected from your API <strong>Request<\/strong> payload.<\/p>\n<p class=\"wysiwyg-indent2\">You can also configure an information task request using <strong>SOAP<\/strong> in which case you need to configure the <strong>WSDL URL<\/strong>, and\u00a0<strong>Connectors.<\/strong><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<span class=\"collapseomatic \" id=\"apirequest-rest\"  tabindex=\"0\" title=\"API Request - Rest\"    >API Request - Rest<\/span><div id=\"target-apirequest-rest\" class=\"collapseomatic_content \"><br \/>\nAfter you describe the Bot action task on the <strong>General<\/strong> tab, and optionally,\u00a0define authentication requirements on the <strong>API Request<\/strong> tab, you are ready to start configuring the API request that asks for data from your Bot website, system, or web application for the task.<br \/>\nThis topic describes how to configure an API (REST) Request.<br \/>\nSee below for <a href=\"#apirequest-soap\">API (SOAP) requests<\/a>.<br \/>\n<span class=\"collapseomatic \" id=\"id6ae85d219e7aa\"  tabindex=\"0\" title=\"Configuring API Request (REST)\"    >Configuring API Request (REST)<\/span><div id=\"target-id6ae85d219e7aa\" class=\"collapseomatic_content \"><br \/>\nFor an action task request with\u00a0the <strong>Connection Mode<\/strong>\u00a0set to\u00a0<strong>REST<\/strong>, you need to define the following:<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/API-Request-page.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14069\" src=\"\/wp-content\/uploads\/sites\/18\/API-Request-page.png\" alt=\"\" width=\"816\" height=\"431\" \/><\/a><\/p>\n<ul>\n<li><strong>Authorization<\/strong> &#8211;\u00a0If required for your action task, you will need to define the authorization to access the API. For example, using basic authorization, OAuth, or API Key. For more information, see above section &#8211; <a href=\"#auth\">Authorization Settings<\/a>.<\/li>\n<li><strong>Parameters<\/strong> &#8211; Define one or more parameters used to process the API request. Examples: input from user prompts, selection by an end-user from a list of choices, a URL, and more. For more information, see below &#8211; <a href=\"#ActReq\">Defining Parameters for an Action Task<\/a>.<\/li>\n<li><strong>Initializer (<\/strong><em>Optional<\/em><strong>)<\/strong> &#8211; Specify custom JavaScript to run, set session variables prior to creating a task instance when web services require a code to be executed, set session variables, or modify user context details before an API request is executed. For more information, see below &#8211; <a href=\"#initial\">Defining an Initializer<\/a>.<\/li>\n<li><strong>Request<\/strong> &#8211; Define a request chain used to make an API call to a web service to initiate the action task using URLs and paths to your Bot and to initiate the delivery of the data payload from the web service to the Bots Platform. The request chain can consist of pre-processors, API request, and post-processors. For more information, see below &#8211; <a href=\"#request\">Defining the Request Chain<\/a>.<\/li>\n<li><strong>Response Sample<\/strong> &#8211; Define key\/value pairs that you expect to receive in the Action task payload. The keys that you provide\u00a0are available as drop-down choices for handling the\u00a0data to display to the bot user. For more information, see below &#8211;<a href=\"#response\">Adding the Response Sample<\/a>.<\/li>\n<\/ul>\n<p><\/div><br \/>\n<span class=\"collapseomatic \" id=\"ActReq\"  tabindex=\"0\" title=\"Defining Parameters\"    >Defining Parameters<\/span><div id=\"target-ActReq\" class=\"collapseomatic_content \"><br \/>\nFollow these steps to define an API Request (REST) parameters:<\/p>\n<ol>\n<li>Click the <strong>Parameters<\/strong> section, and then click <strong>Add.\u00a0\u00a0<\/strong>The <em>Set Up Task Parameter<\/em> dialog opens.<\/li>\n<li>Depending on your selection, enter the values for the relevant fields as described in the following table.<br \/>\n<table>\n<thead>\n<tr>\n<th>Field Name<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Type of Task Parameter<\/td>\n<td>\n<p>Specify one of the following:<\/p>\n<ul>\n<li><strong>Payload Parameter<\/strong>\u00a0&#8211; Use this field type to represent payload data for an HTTP method, such as POST, PUT, GET, DELETE, and so forth. For example:\n<pre class=\"lang:default decode:true \">{\r\n   \"taskId\":\"{payloadfield2}\",\r\n   \"message\":\"{payloadfield1}\"\r\n}<\/pre>\n<\/li>\n<li><strong>Query Parameter<\/strong>\u00a0&#8211; This field type is used as part of a URL path or query within a\u00a0URL. For example:<br \/>\n<code>http:\/\/app.asana.com\/api\/workspaces\/<span class=\"s1\"><strong>{queryfield1}<\/strong>\/project\/<strong>{queryfield2}<\/strong>?userId=<strong>{queryfield3}<\/strong><\/span><\/code><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Parameter Name<\/td>\n<td>The title of the task input\u00a0field displayed to the user, for example, <i>Choose account<\/i><\/td>\n<\/tr>\n<tr>\n<td>Prompt Message<\/td>\n<td>The help description displayed below the parameter name, for example, <i>Which account would you like to access?<\/i><\/td>\n<\/tr>\n<tr>\n<td>Parameter Key<\/td>\n<td>The task\u00a0key that represents the end-user input value that you want to collect, for example, <i>accountType<\/i>.<\/td>\n<\/tr>\n<tr>\n<td>Entity Type<\/td>\n<td>\n<p>The input parameter will be associated with an Entity and you can choose the Entity Type from:<\/p>\n<ul>\n<li>Attachment<\/li>\n<li>City<\/li>\n<li>Country<\/li>\n<li>Company<\/li>\n<li>Currency<\/li>\n<li>Date<\/li>\n<li>Email<\/li>\n<li>Label<\/li>\n<li>Location<\/li>\n<li>Message<\/li>\n<li>Name<\/li>\n<li>Number<\/li>\n<li>Percent<\/li>\n<li>Phone Number<\/li>\n<li>String<\/li>\n<\/ul>\n<p>For more information on Entity Types <a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/dialog-task\/entity-types\/\">click here<\/a>.<br \/>\nBased upon the Entity Type selected the remaining Parameters are set, you can modify the same.<\/td>\n<\/tr>\n<tr>\n<td>Parameter Type<\/td>\n<td>\n<p>Specifies the type of task input\u00a0field displayed in the end-user interface to collect user input for the request object to assign to the <strong>Key<\/strong> value. The default setting is <strong>Textbox<\/strong>, but can be customized to any one of the following:<\/p>\n<ul>\n<li><strong>Date<\/strong> &#8211; Displays the <strong>Format<\/strong> field where you can select the\u00a0date format syntax\u00a0for the end-user to define when the task\u00a0is configured for their account. In the <strong>Select Date Format<\/strong> drop-down list, select one of the following:\n<ul>\n<li><strong>dd-MM-YYYY<\/strong>\u00a0&#8211; For example,\u00a0<span style=\"color: #0000ff\">16-05-1999<\/span><\/li>\n<li><strong>MM-dd-YYYY<\/strong>\u00a0&#8211; For example,\u00a0<span style=\"color: #0000ff\">05-16-1999<\/span><\/li>\n<li><strong>dd-MM-YY<\/strong>\u00a0&#8211; For example,\u00a0<span style=\"color: #0000ff\">16-05-99<\/span><\/li>\n<li><strong>YYYY-MM-dd<\/strong> &#8211; For example,\u00a0<span style=\"color: #0000ff\">1999-05-16<\/span><\/li>\n<\/ul>\n<\/li>\n<li><strong>URL<\/strong> &#8211; Displays a text box for the end-user to enter a URL including field validation for a correct URL syntax. In the <strong>Placeholder<\/strong> field, enter the help hint displayed in the text box, for example, <span style=\"color: #0000ff\">Enter the URL for the website here.<\/span><\/li>\n<li><strong>Textbox<\/strong> &#8211; Displays a text box for the end-user to enter text as the task input field, typically just a few words. In the <strong>Placeholder<\/strong> field, enter the help hint displayed in the text field, for example, <span style=\"color: #0000ff\">Type\u00a0in the name you want to embroider.<\/span><\/li>\n<li><strong>Static Dropdown<\/strong> &#8211; Displays a drop-down list of choices to the end-user. Click <strong>Add Option<\/strong> to begin adding the list of items to display to the end-user with the following parameters:\n<ul>\n<li><strong>Option Name <\/strong>&#8211; The name of the option displayed to the end-user.<\/li>\n<li><strong>Option Value<\/strong> &#8211; The value the represents the <strong>Option Name<\/strong>\u00a0returned to the application.<\/li>\n<li><strong>Default Value<\/strong> &#8211; Select the default value for the option when more than one option is defined.<\/li>\n<li><strong>Searchable<\/strong> &#8211; Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.<\/li>\n<\/ul>\n<p>Click <strong>Save<\/strong>. To add additional items, click <strong>Add Option<\/strong> again. Edit or remove options in the <b>Actions<\/b> column for options.<\/li>\n<li><strong>Dynamic Dropdown<\/strong> &#8211; 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 <em>JIRA<\/em>\u00a0task notification. Define the following properties for a dynamically populated dropdown.\n<ul>\n<li><strong>Endpoint URL<\/strong> &#8211; The Bot\u00a0endpoint URL, for example,\u00a0<span style=\"color: #0000ff\">https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/li>\n<li><strong>Endpoint Content Type<\/strong> &#8211; The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, URL Encoded JSON, CCV, Text, or Twitter Encoded JSON.<\/li>\n<li><strong>Endpoint Method<\/strong> &#8211; One of:\n<ul>\n<li><strong>GET<\/strong> &#8211; Specifies an HTTP Request GET method for the task\u00a0field.<\/li>\n<li><strong>POST<\/strong> &#8211; Specifies an HTTP Request POST method for the task\u00a0field.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Response Path<\/strong> &#8211; The path in the response that contains the desired drop-down list values, for example, <span style=\"color: #0000ff\">data<\/span>.<\/li>\n<li><strong>Label Key<\/strong> &#8211; The key for the label of the drop-down option, for example, <span style=\"color: #0000ff\">name<\/span>.<\/li>\n<li><strong>Option Value Key<\/strong> &#8211; The key for the value of the drop-down option, for example, <span style=\"color: #0000ff\">id<\/span>.<\/li>\n<li><strong>Add Payload Field<\/strong> &#8211; Click to add one or more fields from the response payload as options for the dynamic dropdown. For each payload field, enter the <strong>Payload field key<\/strong> and the <strong>Payload field value<\/strong>, and then click <strong>Save<\/strong>. Edit or delete payload fields in the <strong>Actions<\/strong> column.<\/li>\n<li><strong>Searchable<\/strong> &#8211; Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<ul>\n<li><strong>Textarea<\/strong> &#8211; Displays a text area box for the end-user to enter text as the task\u00a0input, typically for several sentences. In the <strong>Placeholder<\/strong> field, enter the help hint displayed inside the text area.<\/li>\n<li><strong>Type Ahead<\/strong>\u00a0&#8211; 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\u00a0URL defined for the task. For example, a list of projects for a <em>JIRA<\/em>\u00a0task notification message. Define the following properties for a dynamically populated drop-down.\n<ul>\n<li><strong>Endpoint URL<\/strong> &#8211; The Bot\u00a0endpoint URL, for example,\u00a0<span style=\"color: #0000ff\">https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/li>\n<li><strong>Endpoint Content Type<\/strong> &#8211; 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.<\/li>\n<li><strong>Endpoint Method<\/strong> &#8211; One of:\n<ul>\n<li><strong>GET<\/strong> &#8211; Specifies an HTTP Request GET method for the task\u00a0field.<\/li>\n<li><strong>POST<\/strong> &#8211; Specifies an HTTP Request POST method for the task\u00a0field.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Response Path<\/strong> &#8211; The path in the response that contains the desired drop-down list values, for example, <span style=\"color: #0000ff\">data<\/span>.<\/li>\n<li><strong>Label Key<\/strong> &#8211; The key for the label of the drop-down option, for example, <span style=\"color: #0000ff\">name<\/span>.<\/li>\n<li><strong>Option Value Key<\/strong> &#8211; The key for the value of the drop-down option, for example, <span style=\"color: #0000ff\">id<\/span>.<\/li>\n<li><strong>Add Payload Field<\/strong> &#8211; Click to add one or more fields from the response payload as options for the type ahead field. For each type ahead field option, enter the <strong>Payload field key<\/strong> and the <strong>Payload field value<\/strong>, and then click <strong>Save<\/strong>. Edit or delete payload fields in the <strong>Actions<\/strong> column.<\/li>\n<li><strong>Editable<\/strong> &#8211; Enables the end-user to enter text free-from in the field as an option when type-ahead search results do not match.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Email<\/strong> &#8211; Displays a text box for the end-user to input\u00a0an email address. In the <strong>Placeholder<\/strong> field, enter the help hint to display to the end-user inside\u00a0the text box.<\/li>\n<li><strong>Date &amp; Time<\/strong> &#8211; Displays a text box for the end-user to input\u00a0a date with\u00a0time. In the <strong>Format<\/strong> field, enter the expected date or time format to display to the end-user in the date text box. In the <strong>Select Date Format<\/strong> drop-down list, select the date with\u00a0time format.<\/li>\n<li><strong>Time Zone<\/strong> &#8211; Displays a drop-down list of time zones based on the operating system settings.<\/li>\n<li><strong>Location<\/strong> &#8211; Displays a text box for the end-user to enter a geographical location, for example, <span style=\"color: #0000ff\">Orlando, FL<\/span>, or <span style=\"color: #0000ff\">32801<\/span>.<\/li>\n<li><strong>Nested Form<\/strong> &#8211; Displays end-user input fields in a nested format below the parent input field. Specify the following fields for a nested form input field:\n<ul>\n<li><strong>Array Element\u00a0Type<\/strong> &#8211; Select\u00a0the data type of the parent input form element.<\/li>\n<li><strong>Add Nested Form Field<\/strong> &#8211; Click to add one or more nested form fields.<\/li>\n<\/ul>\n<\/li>\n<li><strong>File Upload<\/strong> &#8211; Displays end-user control to search for, and select a file to upload. When clicked, enter the <strong>File Upload Payload Key<\/strong>. When the <strong>File Upload Payload Key<\/strong> is defined, in the <strong>File Upload Payload Field Value<\/strong> drop-down list, select one of the following types:\n<ul>\n<li><strong>File Name<\/strong><\/li>\n<li><strong>File Size<\/strong><\/li>\n<li><strong>File Content Type<\/strong><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Data Type<\/td>\n<td>\n<p>Select one of these user input types:<\/p>\n<ul>\n<li><strong>String<\/strong> &#8211; Users can input any sequence of numbers, letters, or special characters.<\/li>\n<li><strong>Number<\/strong> &#8211; Users can input a number. No special characters are allowed.<\/li>\n<li><strong>Boolean<\/strong> &#8211; User can input a Boolean value of <span style=\"color: #0000ff\">true<\/span> or <span style=\"color: #0000ff\">false<\/span>.<\/li>\n<li><strong>Email<\/strong> &#8211; User can input a valid email address.<\/li>\n<li><strong>Object<\/strong> &#8211; Data from a Bot\u00a0can be received as JSON objects, for example, as location details defined as:<br \/>\n<span style=\"color: #0000ff\">\u00a0&#8220;location&#8221; : {<br \/>\n<\/span><span style=\"color: #0000ff\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0&#8220;lat&#8221; : 17.4374614,<br \/>\n<\/span><span style=\"color: #0000ff\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0&#8220;lng&#8221; : 78.4482878<\/span><br \/>\n<span style=\"color: #0000ff\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span><br \/>\nwhere you can refer to the properties in a request chain or task\u00a0request as <span style=\"color: #0000ff\">location.lat<\/span>, and <span style=\"color: #0000ff\">location.lng<\/span>.<\/li>\n<li><strong>Array<\/strong> &#8211; Users can pass a comma-separated list of values to the Bot. For example, in <em>Google Calendar<\/em>, multiple attendees with data can be passed as:<br \/>\n<span style=\"color: #0000ff\">&#8220;attendees&#8221;: [&#8220;user1&#8221;, &#8220;user2&#8221;, &#8220;user3&#8221;]<br \/>\n<\/span>When selected, specify the <strong>Type<\/strong> for the array of end-user input as one of:<\/p>\n<ul>\n<li><strong>String<\/strong><\/li>\n<li><strong>Number<\/strong><\/li>\n<li><strong>Boolean<\/strong><\/li>\n<li><strong>Email<\/strong><\/li>\n<li><strong>Array<\/strong><\/li>\n<li><strong>Date<\/strong><\/li>\n<\/ul>\n<\/li>\n<li><strong>Date<\/strong> &#8211; Users can type a complete date or select <span style=\"background-color: #f6d5d9\">it\u00a0<\/span>from a date picker.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Mandatory<\/td>\n<td>Select if the\u00a0end-user must define this setting to save the task\u00a0settings configuration.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>Click the\u00a0<strong>Advanced Settings<\/strong>\u00a0tab to define additional optional settings for the task fields.<\/li>\n<\/ol>\n<table>\n<thead>\n<tr>\n<th>Field Name<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Visibility<\/td>\n<td>Specify if the task input\u00a0field should be visible or hidden from the end-user.<br \/>\nThe <strong>Visibility<\/strong> field can also be set to <strong>Custom<\/strong> 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:<br \/>\n&#8220;@Mike, please look into this issue&#8221;<br \/>\nThe JIRA API to &#8216;Post a comment&#8217; requires one query field and one payload field as:<\/p>\n<ul>\n<li>Issue ID<\/li>\n<li>Comment<\/li>\n<\/ul>\n<p>With the <strong>Visibility<\/strong> field set to <strong>Custom<\/strong>, you can capture the user information for the user mentioned as <code>@Mike<\/code> using the JIRA API to fetch data to append to the <code>comment<\/code> field value, but not to use as payload field or query field. The default <strong>Visibility<\/strong> field setting is <strong>Visible<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>Untranspose the Key<\/td>\n<td>Select to disable key transposition by Kore.ai. By default, Kore.ai transposes a key\/value pair, for example, &#8220;parameter&#8221;:&#8221;value&#8221; is transposed by Kore.ai to &#8220;parameter:{value:&#8221;actualValue&#8221;}. When selected, keys are not transposed.<\/td>\n<\/tr>\n<tr>\n<td>Fetch from Session<\/td>\n<td>\n<p>Select to store the user input value for this field as a session variable. When selected, the <strong>Field Value from Session<\/strong> field is displayed. Select an existing variable, or select <strong>Add New Session Variable<\/strong> to define a new variable. To create a new session variable, you must select the <strong>Scope<\/strong> of the variable and define the <strong>Key<\/strong> to store the variable. In the <b>Scope<\/b> field, select one of:<\/p>\n<ul>\n<li><strong>EnterpriseContext<\/strong> &#8211; Define a key\/value pair available to all users in an enterprise.<\/li>\n<li><strong>BotContext<\/strong> &#8211; Define a key\/value pair available to all users of this bot.<\/li>\n<li><strong>UserSession<\/strong> &#8211; Define a key\/value pair available for this user for any bots in an enterprise.<\/li>\n<li><strong>BotUserSession<\/strong> &#8211; Define a key\/value pair available a bot based on user inputs.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<ul>\n<li>Click <strong>Add &amp; Continue<\/strong>\u00a0to save the parameter\u00a0for the task\u00a0request and add another parameter, or click\u00a0<strong>Add &amp; Exit<\/strong>\u00a0to save the parameter\u00a0for the task\u00a0request and close the dialog. You should organize multiple parameters\u00a0in the order that the bot user should provide inputs. Use the\u00a0<img loading=\"lazy\" decoding=\"async\" class=\"inline\" src=\"\/wp-content\/uploads\/sites\/18\/MoveDownIcon.png\" alt=\"\" width=\"22\" height=\"24\" \/>\u00a0and\u00a0<img loading=\"lazy\" decoding=\"async\" class=\"inline\" src=\"\/wp-content\/uploads\/sites\/18\/MoveUpIcon.png\" alt=\"\" width=\"22\" height=\"24\" \/>\u00a0icons to move the parameters.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabParametersSectionSort.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9786\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabParametersSectionSort.png\" alt=\"Action Task - API Request Tab - Parameters Section - Sort\" width=\"872\" height=\"368\" \/><\/a><\/li>\n<\/ul>\n<p><\/div><br \/>\n<span class=\"collapseomatic \" id=\"initial\"  tabindex=\"0\" title=\"Defining an Initializer\"    >Defining an Initializer<\/span><div id=\"target-initial\" class=\"collapseomatic_content \"><br \/>\nTo run a task, you may need to put or get values from a session before executing the task using Kore.ai session-specific variables.\u00a0 For more information, see <a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/dialog-task\/using-session-and-context-variables-in-tasks\/\">Using Session and Context Variables in Tasks<\/a>.<br \/>\nSome web services require executed code, session variables, or modification of user context details before executing an API request. For example, a web service may require two-factor user authorization where the first step is a user login, and the second step is a partner authorization. After validating both these steps, an access token is granted and used in the header of subsequent API calls to that web service. Using the <strong>Initializer<\/strong>, you can complete partner authorization and retrieve the access token from the response of the user authentication. The access token can be stored as a custom session variable and set as the header for subsequent API calls.<\/p>\n<h4>Defining Task Initializer<\/h4>\n<p>To configure the task initializer, click the <strong>Initializer<\/strong> tab. It opens a JavaScript editor in which you can write the required code.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabInitializerSection.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9792\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabInitializerSection.png\" alt=\"Action Task - API Request Tab - Initializer Section\" width=\"1018\" height=\"448\" \/><\/a><br \/>\nIn the JavaScript editor, define the <strong>Key<\/strong>\u00a0and the <strong>Scope<\/strong> as follows:<\/p>\n<ul>\n<li><strong>EnterpriseContext<\/strong> &#8211; A\u00a0key-value pair available to all bots and all users in an enterprise. For example, for a GitHub bot, a user needs to access one or more enterprise repositories. In the <strong>Initializer<\/strong>, you can persist the repository data as <strong>Gitrepository (Enterprise Context)<\/strong> with the following JavaScript code:\n<pre class=\"lang:default decode:true\">var userRepository = {\r\n\"title\": _labels_[repository],\r\n\"value\": repository\r\n};\r\nEnterpriseContext.put('Gitrepository', userRepository, 200000);<\/pre>\n<\/li>\n<li><strong>BotContext<\/strong> &#8211; A\u00a0key-value pair available to all users of this specific bot. For example, you may want to set up a default currency for financial transactions in a session based on the user location.\u00a0In the <strong>Initializer<\/strong>, you can persist the default currency\u00a0data as <strong>currency (Bot Context)<\/strong> with the following JavaScript code:\n<pre class=\"lang:default decode:true\">var defaultCurrency = { TODO Custom JavaScript for location-based currency }\r\nBotContext.put('currency', defaultCurrency, 200000);<\/pre>\n<\/li>\n<li><strong>UserContext<\/strong> &#8211; A key-value pair available to all bots for a user. These keys are read-only and provided by the system as user data for:\n<ul>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\"><strong>_id<\/strong> &#8211; The Kore.ai userId.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\"><strong>emailId<\/strong> &#8211; The email address associated with the userId.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\"><strong>lastName<\/strong> &#8211; The last name of the user.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\"><strong>firstName<\/strong> &#8211; The first name of the user.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\"><strong>profImage<\/strong> &#8211; The image or avatar filename of the user.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\"><strong>profColour<\/strong> &#8211; The account color for the user.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\"><strong>activationStatus<\/strong> &#8211; The account status of the user.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\"><strong>title<\/strong> &#8211; The title of the user, if defined.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\"><strong>orgId<\/strong> &#8211; The organizational ID of the user account, if defined.<\/span><\/li>\n<\/ul>\n<\/li>\n<li><strong>UserSession<\/strong> &#8211; Define a key-value pair available for this specific user for all bots in an enterprise. For example, you may want to store a user location to make it\u00a0available to all bots, such as a user home address for commerce, transportation, and home\u00a0delivery services.\u00a0In the <strong>Initializer<\/strong>, you can persist the default location\u00a0data as <strong>HomeLocation (UserSession)<\/strong> with the following JavaScript code:\n<pre class=\"lang:default decode:true\">var location = {\r\n \"title\": labels[location],\r\n \"value\": {\r\n \"latitude\": location.latitude,\r\n \"longitude\": request.location.longitude\r\n }\r\n};\r\nUserSession.put('HomeLocation', location, '20000');<\/pre>\n<\/li>\n<li><strong>BotUserSession<\/strong>\u00a0&#8211; Define a key-value pair available to a specific bot based on a specific user&#8217;s inputs. For example, you may want to persist a user location for more than one bot task. For a travel bot, the user may be able to book a flight and a hotel based on the same home and destination addresses.\u00a0In the\u00a0<strong>Initializer<\/strong>, you can persist the default home and destination\u00a0data as <strong>HomeLocation (BotUserSession)<\/strong>\u00a0and <strong>DestinationLocation (BotUserSession)<\/strong> with the following JavaScript code:\n<pre class=\"lang:default decode:true\">var homelocation = {\r\n \"title\": labels[request.sourceLocation],\r\n \"value\": {\r\n \"latitude\": request.sourceLocation.latitude,\r\n \"longitude\": request.sourceLocation.longitude\r\n }\r\n};\r\nBotUserSession.put('HomeLocation', homelocation, '20000');\r\nvar destlocation = {\r\n \"title\": labels[request.destLocation],\r\n \"value\": {\r\n \"latitude\": request.destLocation.latitude,\r\n \"longitude\": request.destLocation.longitude\r\n }\r\n};\r\nBotUserSession.put('DestinationLocation', destlocation, '20000\u2019);<\/pre>\n<\/li>\n<\/ul>\n<h4>GET and PUT Syntax<\/h4>\n<p>The following code examples show the syntax to GET or PUT a key-value pair for each context type.<\/p>\n<pre class=\"lang:default decode:true\">\"EnterpriseContext\" : {\r\n       \"get\" : function(key){...},\/\/get the specified key\r\n       \"put\" : function(key, value, ttl){...} \/\/put the value at the key for the specified ttl, ttl is in minutes\r\n   },\r\n   \"BotContext\" : {\r\n       \"get\" : function(key){...},\/\/get the specified key\r\n       \"put\" : function(key, value, ttl){...} \/\/put the value at the key for the specified ttl, ttl is in minutes\r\n   },\r\n   \"UserContext\" : {\r\n       \"get\" : function(key){...},\/\/get the specified key\r\n   },\r\n   \"UserSession\" : {\r\n       \"get\" : function(key){...},\/\/get the specified key\r\n       \"put\" : function(key, value, ttl){...} \/\/put the value at the key for the specified ttl, ttl is in minutes\r\n   },\r\n   \"BotUserSession\" : {\r\n       \"get\" : function(key){...},\/\/get the specified key\r\n       \"put\" : function(key, value, ttl){...} \/\/put the value at the key for the specified ttl, ttl is in minutes\r\n   }<\/pre>\n<p>For example:<\/p>\n<pre class=\"lang:default decode:true\">\u00a0 \u00a0 BotContext.put(\"topicSessionVariable\",\"music\",2000);\r\n\u00a0 \u00a0 UserSession.put(\"firstName\",\"Mary\",20000);\r\n\u00a0 \u00a0 UserContext.get(\"firstName\");<\/pre>\n<h4>Exception Syntax<\/h4>\n<p>You can also define custom error messages to catch errors before setting up a task, for example, authentication failure. If an exception is captured, the task setup is halted. Use the following syntax to throw the exception:<\/p>\n<pre class=\"lang:default decode:true\">{\r\n    \"exceptions\": {\r\n        \"message\": \" Error Message\"\r\n    }\r\n}<\/pre>\n<p>For example,<\/p>\n<pre class=\"lang:default decode:true\">var ex ={};\r\nvar exceptions={};\r\nexceptions.message ='You can not proceed further with out valid permissions';\r\nex.exceptions = exceptions;\r\nprint(JSON.stringify(ex)); \/\/print is mandatory.<\/pre>\n<p>In the <strong>Initializer<\/strong> section, you can use session <strong>Keys<\/strong>, or other session variables, however, you cannot set or access values. For example,<\/p>\n<pre class=\"lang:default decode:true\">var name = UserContext.get(\"firstName\")+UserContext.get(\"lastName\");\r\nUserSession.put(\"fullName\") = name;<\/pre>\n<p>In the preceding code example, you PUT a value into the session using a task\u00a0<strong>Parameter<\/strong>\u00a0defined with the <strong>Fetch from Session<\/strong> field in the <strong>Advanced Settings<\/strong> section for the task. The <strong>Key<\/strong> is defined as <code>fullName<\/code> for the custom defined <code>UserSession<\/code> context variable.<\/p>\n<h4>Task Initializer Example<\/h4>\n<p>The following code is an example of a <strong>Task Initializer<\/strong> to get the user ID and email data to pre-populate variables in the API request.<\/p>\n<pre class=\"lang:default decode:true\">var x = UserContext.get(\"identities\");\r\nvar isEmailFound = false;\r\nfor (var i = 0; i &lt; x.length; i++) {\r\n    if (x[i].type === \"mapped\") {\r\n        var identity = x[i].val\r\n        var arr = identity.split(\"\/\");\r\n        var pattern = \/^cs\/i;\r\n        var result = arr[0].match(pattern);\r\n        if (result) {\r\n            isEmailFound = true;\r\n            UserSession.put(\"rtmEmail\", arr[1], '20000');\r\n        }\r\n    }\r\n}\r\nif (!isEmailFound) {\r\n    for (var j = 0; j &lt; x.length; j++) {\r\n        if (x[j].type === \"email\") {\r\n            UserSession.put(\"rtmEmail\", x[j].val, '20000');\r\n        }\r\n    }\r\n}<\/pre>\n<p><\/div><br \/>\n<span class=\"collapseomatic \" id=\"request\"  tabindex=\"0\" title=\"Defining the Request Chain\"    >Defining the Request Chain<\/span><div id=\"target-request\" class=\"collapseomatic_content \"><br \/>\nIn the Request\u00a0section of the API Request tab, you can define an API request chain consisting of pre-processors, API Requests, and post-processors. At least one API Request is required, while processors are optional.<\/p>\n<h4>API Request<\/h4>\n<p>For any task, you will need to define an API request to make a call to a web service to initiate the task. At least one API request is required for each task. For each API request, you must add one or more request URLs and paths to your task to initiate the delivery of the data payload from the web service.<\/p>\n<h4>Configuring the API Request<\/h4>\n<ol>\n<li>On the <strong>API Request<\/strong> tab, expand the <strong>Request<\/strong> tab, and then click, <strong>Add API<\/strong>.<\/li>\n<li>Specify the values for the fields in the <strong>Add API<\/strong>\u00a0dialog\u00a0as described in the following\u00a0procedure.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Add-API.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14120\" src=\"\/wp-content\/uploads\/sites\/18\/Add-API.png\" alt=\"\" width=\"668\" height=\"599\" \/><\/a><\/li>\n<li>In the <strong>Name<\/strong> field, enter the name of your API request, for example, <em><span style=\"color: #0000ff\">My API Request<\/span><\/em>.<\/li>\n<li>In the<strong> Method<\/strong>\u00a0drop-down list, select the HTTP method used\u00a0for the task. One of:\n<ul>\n<li><strong>POST\u00a0<\/strong>&#8211; Used to send data to the server such as customer information, file upload, using HTML forms.<\/li>\n<li><strong>PUT\u00a0<\/strong>&#8211;\u00a0Replaces the content\u00a0of the target resource with the content sent.<\/li>\n<li><strong>PATCH<\/strong> &#8211; Appends\u00a0the content\u00a0of an existing target resource with the content sent.<\/li>\n<li><strong>DELETE<\/strong> &#8211; Deletes the content of an existing target resource.<\/li>\n<li><strong>GET<\/strong> &#8211; Returns the content of an existing target resource.<\/li>\n<\/ul>\n<\/li>\n<li>In the <strong>URL<\/strong> field,\u00a0specify the URL for the bot task\u00a0response to process, for example,\u00a0<span style=\"color: #0000ff\">http:\/\/koremessenger.com\/postURL<\/span>. You can also use session variables in the URL as shown in the following example:\n<pre class=\"lang:default decode:true \">https:\/\/mySite.crm.ondemand.com\/sap\/c4c\/odata\/v1\/c4codata\/ServiceRequestCollection?$filter=ID eq '{id}' and ReporterEmail eq '{userEmail}'&amp;amp;$expand=ServiceRequestHistoricalVersion,ServiceRequestDescription<\/pre>\n<\/li>\n<li>In the<strong> Access Using A Connector<\/strong>\u00a0field, select <strong>Yes<\/strong> 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 <a href=\"\/v8-1\/docs\/bots\/admin-console\/security-control\/security-module-overview\/#Why_Use_the_Koreai_Connector_for_Bots\">Using the Kore.ai Connector<\/a>.<\/li>\n<li>On the <strong>Headers<\/strong> tab, in the <strong>Content Type<\/strong> field, select one of the following supported data types for your sample response data.\n<ul>\n<li><strong>JSON<\/strong> &#8211;\u00a0JavaScript Object Notation is an open standard format using\u00a0human-readable text to transmit data objects as attribute-value pairs. You can use JSON\u00a0to transmit data between the Kore.ai servers and your Bot\u00a0web application.<\/li>\n<li><strong>RSS<\/strong> &#8211; Rich Site Summary, or Really Simple Syndication, is\u00a0family of standardized formats used to publish frequently updated information\u00a0such as blog entries, news headlines, audio, and video.<\/li>\n<li><strong>XML<\/strong> &#8211;\u00a0Extensible Markup Language is a markup language that defines a set of rules for encoding documents in a format which is both human-readable and machine-readable. Oftentimes, web services use XML schemas to process the XML data.<\/li>\n<li><strong>URL Encoded JSON<\/strong> &#8211; URLs using JSON encoding for reserved characters.<\/li>\n<li><strong>CSV<\/strong> &#8211; Comma-separated value lists.<\/li>\n<li><strong>Text<\/strong> &#8211; Text-based key-value pairs.<\/li>\n<li><strong>Twitter Encoded JSON<\/strong> &#8211; URLs for Twitter using JSON encoding for reserved characters.<\/li>\n<li><strong>Multipart\/Form-data<\/strong> &#8211; An encoding type that allows files to be sent through an HTTP POST request method if you want to allow a user to upload a file from a form<b>.<\/b><\/li>\n<li><strong>Multipart\/Related<\/strong> &#8211; Used when the same information is presented in different body parts in different forms. The body parts are ordered by increasing complexity.<\/li>\n<li><strong>Oracle ADF<\/strong> &#8211; For Oracle Application Development Framework.<\/li>\n<\/ul>\n<\/li>\n<li>In the <strong>Authorization Headers<\/strong> section, select or clear keys to enable or disable the key for the header as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabRequestSectionAddAPIDialogAuthHeaders.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9796\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabRequestSectionAddAPIDialogAuthHeaders.png\" alt=\"Action Task - API Request Tab - Request Section - Add API Dialog - Auth Headers\" width=\"534\" height=\"263\" \/><\/a><\/li>\n<li>On the <strong>Parameters<\/strong> tab, select or clear\u00a0any <strong>Auth Parameters<\/strong> or <strong>Parameters<\/strong> to include in the header as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabRequestSectionAddAPIDialogParams.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9797\" src=\"\/wp-content\/uploads\/sites\/18\/DIYActionTaskAPIRequestTabRequestSectionAddAPIDialogParams.png\" alt=\"Action Task - API Request Tab - Request Section - Add API Dialog - Params\" width=\"567\" height=\"317\" \/><\/a><\/li>\n<li>Click <strong>Save<\/strong> to save and close the API Request configuration.<\/li>\n<\/ol>\n<h4>Processors<\/h4>\n<p>Processors allow you to manipulate data collected in the user session before, during, or after an API request to a web service using JavaScript.<br \/>\nIf you define and place a processor before the API Request, it is a pre-processor. Pre-processors allow you to\u00a0manage input parameters and values from session variables before the API Request is made.<br \/>\nIf the processor is sequentially placed after the API Request, it is a post-processor. You can use a post-processor to access payload response keys from the API request. To access keys, use one of the following post-processor types:<\/p>\n<ul>\n<li><strong>Resolve:\u00a0<\/strong>To use the results of one payload response as input for a second request.<\/li>\n<li><strong>Spread<\/strong> &#8211; To separate arrays of data in a payload.<\/li>\n<li><strong>Extract<\/strong> &#8211;\u00a0To specify a path to a specific object in a payload with multiple objects.<\/li>\n<li><strong>Assign<\/strong> &#8211; To specify a variable name for the payload response.<\/li>\n<\/ul>\n<h4>Pre-processors<\/h4>\n<p>You can use a\u00a0pre-processor to manage request parameters before the API Request is executed, using session variables and parameters. When defining a pre-processor, you must set <strong>Type of Process<\/strong> to <strong>custom<\/strong> and then enter your\u00a0code in the JavaScript editor displayed. A pre-processor can only be of <strong>Type custom<\/strong>.<\/p>\n<h5>Adding a Pre-Processor<\/h5>\n<ol>\n<li>On the <strong>API Request<\/strong> page, expand the <strong>Request<\/strong>\u00a0tab, and then click <strong>Add Processor<\/strong>.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Add-Request.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14105\" src=\"\/wp-content\/uploads\/sites\/18\/Add-Request.png\" alt=\"\" width=\"1067\" height=\"296\" \/><\/a><\/li>\n<li>Enter the name of your processor in the <strong>Name<\/strong> field.<\/li>\n<li>In the <strong>Type of Process<\/strong> drop-down list, you must select <strong>Custom<\/strong> for a pre-processor.<\/li>\n<li>Add your code for manipulating the request parameters as needed using the following syntax:\n<pre class=\"lang:default decode:true \">{\r\n    \"fields\": {\r\n        \"payloadFields\": { \/\/ to set value to a payload field\r\n            \"key1\": \"value1\", \/\/ Payload fields are not applicable for Alert tasks.\r\n            \"key2\": \"value2\"....\r\n        },\r\n        \"headerFields\": { \/\/ to set value to a header field\r\n            \"key1\": \"value1\",\r\n            \"key2\": \"value2\"....\r\n        },\r\n        \"pathFields\": { \/\/ to set value to a path field or query field.\r\n            \"key1\": \"value1\",\r\n            \"key2\": \"value2\"....\r\n        }\r\n    }\r\n}<\/pre>\n<p>For example, the following code snippet can be used to set the path field or the query field of an API object:<\/p>\n<pre class=\"lang:default decode:true\">var fields= {};\r\nvar pathFields = {};\r\npathFields.fullName = UserContext.get(\"firstName\")+UserContext.get(\"lastName\")\r\nfields.pathFields = pathFields;\r\nvar finalObject = {};\r\nfinalObject.fields = fields;\r\nprint(JSON.stringify(finalObject));<\/pre>\n<p>In the previous code, if <code>firstName<\/code> and <code>lastName<\/code> are stored as session variables, as <code>John<\/code> and <code>Smith<\/code> respectively, then the JSON response payload from the pre-processor would be:<\/p>\n<pre class=\"lang:default decode:true\">{\r\n    fields: {\r\n        \"pathFields\": {\r\n            \"key\": \"fullName\",\r\n            \"value\": \"John Smith\"\r\n        }\r\n    }\r\n}<\/pre>\n<p>In the following pre-processor example, variables are set with session variables prior to the actual API request call.<\/p>\n<pre class=\"lang:default decode:true \">var fields = {};\r\nvar pathFields = {};\r\nvar UserEmailID = UserSession.get(\"rtmEmail\");\r\npathFields.userEmail = UserEmailID;\r\nfields.pathFields = pathFields;\r\nvar finalObject = {};\r\nfinalObject.fields = fields;\r\nprint(JSON.stringify(finalObject));<\/pre>\n<\/li>\n<li>Click <strong>Save<\/strong> to save and close the <strong>Add Processor<\/strong> dialog.<\/li>\n<\/ol>\n<div class=\"alert alert-info\">When a processor is placed in the <strong>Request<\/strong>\u00a0section before the API Request, the processor is considered as a pre-processor. When placed after an API Request, the processor is considered a post-processor.<\/div>\n<h4>Adding a Post-Processor<\/h4>\n<p>You may need more than one API request to get the desired data payload from your web service, using Kore.ai post-processors.<\/p>\n<h4>Defining a Custom Post-Processor<\/h4>\n<p>If you want to create a custom post-processor, you could access the response keys of the previous API Request using the following syntax&#8221;<\/p>\n<p class=\"p1\"><span class=\"s1\" style=\"color: #0000ff\"><i>payload[0].{ key }<\/i><\/span><\/p>\n<h5 class=\"p1\"><strong>JSON Syntax<\/strong><\/h5>\n<pre class=\"lang:default decode:true\">{\r\n \"payload\":\r\n   {\r\n    \"key1\" : \"value1\",\r\n    \"key2\" : \"value2\"\r\n   }\r\n}<\/pre>\n<h5><strong>Example<\/strong><\/h5>\n<pre class=\"lang:default decode:true\">var final = {};\r\nvar data = payload[0]; \/\/Accessing the response of the previous API object\r\ndata.title[0] = 'New value for key here';\r\nfinal.payload = data;  \/\/ Updating the response of the API object\r\nprint(JSON.stringify(final));  \/\/ This step is mandatory<\/pre>\n<p>For custom processors, you must print the final response as shown in the preceding code, otherwise, an empty response is returned. Use the following syntax:<\/p>\n<pre class=\"lang:default decode:true \">print(JSON.stringify( &lt;&lt;object&gt;&gt; ));<\/pre>\n<h4>Configuring Standard Post Processors<\/h4>\n<p>Follow these steps to add a standard post processor:<\/p>\n<ol>\n<li>On the <strong>API Request<\/strong> tab, expand the <strong>Request<\/strong>\u00a0tab, and then click <strong>Add Processor<\/strong>.<\/li>\n<li>Kore.ai also provides a set of standard post-processors that you can use instead of creating custom code for a post-processor. In <strong>Type of Process<\/strong> field, select one of the following four types of standard processors:\n<ol>\n<li><strong>Resolve<\/strong>: You can\u00a0use the results of one payload response as input for a second request. For example, click <strong>Add Processor<\/strong>, enter a <strong>Name<\/strong> for your processor, set <strong>Type of Process<\/strong> to <strong>resolve<\/strong>, and\u00a0<strong>Key<\/strong> to the name of the variable, and then define the <strong>Post\u00a0URL<\/strong> using a variable from the first API Request. For example, <span style=\"color: #0000ff\">https:\/\/app.asana.com\/api\/1.0\/projects\/<strong>{project_id}<\/strong><\/span>\u00a0that returns the <span style=\"color: #0000ff\">id<\/span> field in the payload response as:\n<pre class=\"lang:default decode:true\"> ...\r\n\"id\":80468818418144, &lt;br\/&gt;\r\n\"created_at\":\"2016-01-14T05:34:35.848Z\",\r\n\"modified_at\":\"2016-01-20T04:29:52.505Z\",\r\n\"owner\":{\r\n\"id\":73114591129714,\r\n\"name\":\"jaganmohan.evuri\" },\r\n...<\/pre>\n<p>that is then used as a variable input as shown in the following <strong>Post URL<\/strong>:<br \/>\n<span style=\"color: #0000ff\"> https:\/\/app.asana.com\/api\/1.0\/projects\/<strong>{id}<\/strong>\/tasks?opt_fields=completed,modified_at<\/span><br \/>\nYou must also specify the HTML <strong>Content Type<\/strong> expected in the payload response as well as the HTML <strong>Request<\/strong> method.<br \/>\nFor more information, see <a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/dialog-task\/using-session-and-context-variables-in-tasks\/\">Using Session and Context Variables in Tasks<\/a>.<\/li>\n<li><strong>Spread<\/strong>: For payloads that contain arrays of data that you need to separate. For example, click <strong>Add Processor<\/strong>, enter a <strong>Name<\/strong> for your processor, set the\u00a0<strong>Key<\/strong>\u00a0field to, for example,\u00a0<strong>data<\/strong>, and <strong>Type of Process<\/strong> to <strong>spread<\/strong>\u00a0to capture the content in the <code>data<\/code> element in the following code example to extract each item of the array.\n<pre class=\"lang:default decode:true\"> {\r\n     \"attribution\": null,\r\n     \"tags\": [],\r\n     \"type\": \"image\",\r\n     \"location\": null,\r\n     \"comments\": {\r\n         \"count\": 51,\r\n         \"data\": [{\r\n             \"created_time\": \"1453900980\",\r\n             \"text\": \"43rd\",\r\n             \"from\": {\r\n                 \"username\": \"kore_hyd\",\r\n                 \"profile_picture\": \"https:\/\/scontent.cdninstagram.com\/t51.2885-19\/11906329_960233084022564_1448528159_a.jpg\",\r\n                 \"id\": \"2056218675\",\r\n                 \"full_name\": \"Kore.ai Hyd\"\r\n             },\r\n             \"id\": \"1171728804843572377\"\r\n         }, {\r\n             \"created_time\": \"1453901222\",\r\n             \"text\": \"44th\",\r\n             \"from\": {\r\n                 \"username\": \"kore_hyd\",\r\n                 \"profile_picture\": \"https:\/\/scontent.cdninstagram.com\/t51.2885-19\/11906329_960233084022564_1448528159_a.jpg\",\r\n                 \"id\": \"2056218675\",\r\n                 \"full_name\": \"Kore.ai Hyd\"\r\n             },\r\n             \"id\": \"1171730841379491107\"\r\n         }, {\r\n             \"created_time\": \"1453901997\",\r\n             \"text\": \"45th\",\r\n             \"from\": {\r\n                 \"username\": \"kore_hyd\",\r\n                 \"profile_picture\": \"https:\/\/scontent.cdninstagram.com\/t51.2885-19\/11906329_960233084022564_1448528159_a.jpg\",\r\n                 \"id\": \"2056218675\",\r\n                 \"full_name\": \"Kore.ai Hyd\"\r\n             },\r\n             \"id\": \"1171737339782450909\"\r\n         }, {\r\n             \"created_time\": \"1453902304\",\r\n             \"text\": \"46th and 47th\",\r\n             \"from\": {\r\n                 \"username\": \"kore_hyd\",\r\n                 \"profile_picture\": \"https:\/\/scontent.cdninstagram.com\/t51.2885-19\/11906329_960233084022564_1448528159_a.jpg\",\r\n                 \"id\": \"2056218675\",\r\n                 \"full_name\": \"Kore.ai Hyd\"\r\n             },\r\n             \"id\": \"1171739915923967873\"\r\n         }, {\r\n             \"created_time\": \"1453902638\",\r\n             \"text\": \"48th\",\r\n             \"from\": {\r\n                 \"username\": \"kore_hyd\",\r\n                 \"profile_picture\": \"https:\/\/scontent.cdninstagram.com\/t51.2885-19\/11906329_960233084022564_1448528159_a.jpg\",\r\n                 \"id\": \"2056218675\",\r\n                 \"full_name\": \"Kore.ai Hyd\"\r\n             },\r\n             \"id\": \"1171742713994497101\"\r\n         }, {\r\n             \"created_time\": \"1453964684\",\r\n             \"text\": \"49th\",\r\n             \"from\": {\r\n                 \"username\": \"venkataphani.ailavarapu\",\r\n                 \"profile_picture\": \"https:\/\/scontent.cdninstagram.com\/t51.2885-19\/11906329_960233084022564_1448528159_a.jpg\",\r\n                 \"id\": \"2679234818\",\r\n                 \"full_name\": \"Phani\"\r\n             },\r\n             \"id\": \"1172263199715314941\"\r\n         }, {\r\n             \"created_time\": \"1453964710\",\r\n             \"text\": \"50th\",\r\n             \"from\": {\r\n                 \"username\": \"kore_hyd\",\r\n                 \"profile_picture\": \"https:\/\/scontent.cdninstagram.com\/t51.2885-19\/11906329_960233084022564_1448528159_a.jpg\",\r\n                 \"id\": \"2056218675\",\r\n                 \"full_name\": \"Kore.ai Hyd\"\r\n             },\r\n             \"id\": \"1172263415747136776\"\r\n         }, {\r\n             \"created_time\": \"1453964717\",\r\n             \"text\": \"51st\",\r\n             \"from\": {\r\n                 \"username\": \"kore_hyd\",\r\n                 \"profile_picture\": \"https:\/\/scontent.cdninstagram.com\/t51.2885-19\/11906329_960233084022564_1448528159_a.jpg\",\r\n                 \"id\": \"2056218675\",\r\n                 \"full_name\": \"Kore.ai Hyd\"\r\n             },\r\n             \"id\": \"1172263474056350986\"\r\n         }]\r\n           ...<\/pre>\n<\/li>\n<li><strong>Extract<\/strong>: For payloads that contain multiple objects, you can specify a path to the specific object. For example, click <strong>Add Processor<\/strong>, enter a <strong>Name<\/strong> for your processor, set the\u00a0<strong>Key<\/strong>\u00a0field to <code>data<\/code>, and then\u00a0<strong>Type of Process<\/strong> to\u00a0<strong>extract<\/strong> to use the object data in the following payload response.\n<pre class=\"lang:default decode:true\">{\r\n    \"user\": {\r\n        \"full_name\": \"Kore.ai Hyd\",\r\n        \"id\": \"2056218675\",\r\n        \"profile_picture\": \"https:\/\/instagramimages-a.akamaihd.net\/profiles\/anonymousUser.jpg\",\r\n        \"username\": \"kore_hyd\"\r\n    },\r\n    ...\r\n}, \"likes\": {\r\n    \"data\": [{\r\n            \"full_name\": \"kstream002\",\r\n            \"id\": \"2100724876\",\r\n            \"profile_picture\": \"https:\/\/instagramimages-a.akamaihd.net\/profiles\/anonymousUser.jpg\",\r\n            \"username\": \"kstream002\"\r\n        }\r\n    },\r\n    ...\r\n}<\/pre>\n<\/li>\n<li><strong>Assign<\/strong>:\u00a0 Using the <strong>Assign<\/strong> processor, you can specify a variable name for the payload response, if needed, for example, when the payload does not contain a key for the payload response data. For example, set <strong>Type of Process<\/strong> to assign, and then in the\u00a0<strong>Output Variable<\/strong>\u00a0field, you can for example, define an output variable for the following payload that is an array of three\u00a0objects.\n<pre class=\"toolbar:1 lang:default decode:true\">[\r\n  {\r\n    \"Cost\": \"$0.00\",\r\n    \"Desc1\": \"$150 bonus after $500 of purchases in the first 3 months from account opening. \",\r\n    \"Desc2\": \"Earn unlimited cash back Earn unlimited 1.5% cash back on every purchase \u00e2\u20ac\u201c it's automatic. Redeem for cash back \u00e2\u20ac\u201c any amount, any time. \",\r\n    \"Keywords\": \"weekend dining,online,groceries,fuel,rewards,rebate,365,allaround\",\r\n    \"OfferName\": \"Freedom Unlimited\",\r\n    \"OfferType\": \"CreditCard\",\r\n    \"Status\": \"1\",\r\n    \"imageURL\": \"http:\/\/www.psdgraphics.com\/file\/credit-card.jpg\",\r\n    \"id\": \"5b5195e264bbd800\"\r\n  },\r\n  {\r\n    \"Cost\": \"$95.00\",\r\n    \"Desc1\": \"Pay 0 balance transfer fee when you transfer a balance during the first 60 days.\",\r\n    \"Desc2\": \"Jumpstart your financial fitness Get an introductory fee for balance transfers, save on interest\u00e2\u20ac , and get your free monthly credit score.\",\r\n    \"Keywords\": \"privileges,rebate,health,wellness,great eastern,insurance,policy,installments,split,cashflo\",\r\n    \"OfferName\": \"Premium Plus\",\r\n    \"OfferType\": \"CreditCard\",\r\n    \"Status\": \"1\",\r\n    \"imageURL\": \"http:\/\/i.imgur.com\/rMOXYql.jpg\",\r\n    \"id\": \"5caf2155873f89c8\"\r\n  },\r\n  {\r\n    \"Cost\": \"$10.00\",\r\n    \"Desc1\": \"Pay 0 balance transfer fee when you transfer a balance during the first 60 days.\",\r\n    \"Desc2\": \"Jumpstart your financial fitness Get an introductory fee for balance transfers, save on interest\u00e2\u20ac , and get your free monthly credit score.\",\r\n    \"Keywords\": \"privileges,rebate,health,wellness,great eastern,insurance,policy,installments,split,cashflo\",\r\n    \"OfferName\": \"Frequent Flyer\",\r\n    \"OfferType\": \"CreditCard\",\r\n    \"Status\": \"1\",\r\n    \"imageURL\": \"http:\/\/www.moneychoice.org\/wp-content\/uploads\/sites\/18\/2016\/01\/credit-card-calculator-image.png.jpeg\",\r\n    \"id\": \"c0b05bc3062658ee\"\r\n  }\r\n]<\/pre>\n<p>In the <strong>Output Variable<\/strong> field, specify a variable to represent the array, as <code>offers<\/code>, for example. If you used the <strong>UX Preview<\/strong>\u00a0feature, the response from Kore.ai would be:<\/p>\n<pre class=\"toolbar:1 lang:default decode:true\">{\r\n  \"response\": {\r\n    \"offers\": [\r\n      {\r\n        \"Cost\": \"$0.00\",\r\n        \"Desc1\": \"$150 bonus after $500 of purchases in the first 3 months from account opening. \",\r\n        \"Desc2\": \"Earn unlimited cash back Earn unlimited 1.5% cash back on every purchase \u00e2\u20ac\u201c it's automatic. Redeem for cash back \u00e2\u20ac\u201c any amount, any time. \",\r\n        \"Keywords\": \"weekend dining,online,groceries,fuel,rewards,rebate,365,allaround\",\r\n        \"OfferName\": \"Freedom Unlimited\",\r\n        \"OfferType\": \"CreditCard\",\r\n        \"Status\": \"1\",\r\n        \"imageURL\": \"http:\/\/www.psdgraphics.com\/file\/credit-card.jpg\",\r\n        \"id\": \"5b5195e264bbd800\"\r\n      },\r\n      {\r\n        \"Cost\": \"$95.00\",\r\n        \"Desc1\": \"Pay 0 balance transfer fee when you transfer a balance during the first 60 days.\",\r\n        \"Desc2\": \"Jumpstart your financial fitness Get an introductory fee for balance transfers, save on interest\u00e2\u20ac , and get your free monthly credit score.\",\r\n        \"Keywords\": \"privileges,rebate,health,wellness,great eastern,insurance,policy,installments,split,cashflo\",\r\n        \"OfferName\": \"Premium Plus\",\r\n        \"OfferType\": \"CreditCard\",\r\n        \"Status\": \"1\",\r\n        \"imageURL\": \"http:\/\/vignette3.wikia.nocookie.net\/objectmayhem\/images\/5\/52\/Credit_card.png\/revision\/latest?cb=20130629150408\",\r\n        \"id\": \"5caf2155873f89c8\"\r\n      }\r\n    ]\r\n  }\r\n}<\/pre>\n<p>With the <strong>Output Variable<\/strong> set to <code>offers<\/code>, you can use the variable as <code>response.offers<\/code> in Bot Builder, for example, in a task response object as follows:<\/p>\n<pre class=\"toolbar:1 lang:default decode:true \">print(JSON.stringify(response));\r\nvar data = response.offers\r\nfor (i = 0; i &lt; data.length; i++) {\r\n    print('&lt;a href=\"' + data[i].imageURL + '\" target=\"_blank\"&gt;' + data[i].OfferName + '&lt;\/a&gt;&lt;br&gt;');\r\n    print(data[i].Desc1)\r\n    print('&lt;br&gt;');\r\n    print('&lt;br&gt;');\r\n    print('Cost: ' + data[i].Cost)\r\n    print('&lt;br&gt;');\r\n    if (i &lt; data.length - 1) {\r\n        print('&lt;br&gt;');\r\n        print('&lt;br&gt;');\r\n    }\r\n}<\/pre>\n<\/li>\n<\/ol>\n<\/li>\n<li>Click <strong>Add<\/strong> to save the API request and then create another, or click <strong>Add &amp; Exit<\/strong> to save the API request and close the dialog.<\/li>\n<\/ol>\n<p>For multiple API requests, you should order the requests in the sequential order needed to get to entire data response. For example, you may need to request a list of workspaces, then a list of projects, and finally, a list of users. Use the <strong>Move\u00a0Up<\/strong>\u00a0<img loading=\"lazy\" decoding=\"async\" class=\"inline\" src=\"\/wp-content\/uploads\/sites\/18\/MoveUpIcon.png\" alt=\"\" width=\"22\" height=\"24\" \/>\u00a0icon and the <strong>Move Down<\/strong>\u00a0<img loading=\"lazy\" decoding=\"async\" class=\"inline\" src=\"\/wp-content\/uploads\/sites\/18\/MoveDownIcon.png\" alt=\"\" width=\"22\" height=\"24\" \/> icon\u00a0to reorder the API requests.<\/p>\n<div class=\"alert alert-info\"><strong>Note:<\/strong> No confirmation dialog is displayed when deleting an API request. If you click <strong>Continue<\/strong> or <strong>Save<\/strong>, the delete action is permanent and cannot be undone.<\/div>\n<p><\/div><br \/>\n<span class=\"collapseomatic \" id=\"response\"  tabindex=\"0\" title=\"Adding the Response Sample\"    >Adding the Response Sample<\/span><div id=\"target-response\" class=\"collapseomatic_content \"><br \/>\nIn the <strong>Response Sample<\/strong>\u00a0section, you can enter or paste examples of the key-value pairs that you expect to receive in the task payload.\u00a0When you define the response sample, the keys specified\u00a0in the\u00a0<strong>Response Sample<\/strong>\u00a0section are available as drop-down choices for handling the\u00a0output data.<\/p>\n<h4>Adding the Sample Response<\/h4>\n<ol>\n<li>On the <strong>API Request<\/strong> tab, Expand the <strong>Sample Response<\/strong> section.<\/li>\n<li>Enter your Response Sample that contains the key-value pairs from your JSON response payload. Do one of the following:\n<ul>\n<li>To format the view of the response as a JSON structure with indentation as shown in the following\u00a0illustration, click the <strong>Formatted<\/strong> <img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-9801 size-full\" src=\"\/wp-content\/uploads\/sites\/18\/DIYFormattedIcon.png\" width=\"26\" height=\"26\" \/>\u00a0icon.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Sample-response-indent.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14126\" src=\"\/wp-content\/uploads\/sites\/18\/Sample-response-indent.png\" alt=\"\" width=\"1051\" height=\"389\" \/><\/a><\/li>\n<li>To format the view of the response in serialized compact form as shown in the following illustration, click the <strong>Unformatted <img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-9802 size-full\" src=\"\/wp-content\/uploads\/sites\/18\/DIYUnFormattedIcon.png\" width=\"26\" height=\"26\" \/><\/strong>\u00a0icon.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p><\/div><br \/>\n<\/div>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<span class=\"collapseomatic \" id=\"apirequest-soap\"  tabindex=\"0\" title=\"API Request - SOAP\"    >API Request - SOAP<\/span><div id=\"target-apirequest-soap\" class=\"collapseomatic_content \"><br \/>\nAfter you describe the Bot action task on the <strong>General<\/strong> tab, and if required,\u00a0define authentication requirements on the <strong>API Request<\/strong> tab, you are ready to start configuring the API request that asks for data from your Bot website, system, or web application for the task. This topic describes how to configure the request object for an action task with the <strong>Connection Mode<\/strong>\u00a0set to <strong>SOAP<\/strong>.<br \/>\n<span class=\"collapseomatic \" id=\"id6ae85d219f9cc\"  tabindex=\"0\" title=\"Configuring API Request (SOAP)\"    >Configuring API Request (SOAP)<\/span><div id=\"target-id6ae85d219f9cc\" class=\"collapseomatic_content \"><br \/>\nFor an action task request in Kore.ai and the <strong>Connection Mode<\/strong>\u00a0set to <strong>SOAP<\/strong>, you need to define:<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/API-Request.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14129\" src=\"\/wp-content\/uploads\/sites\/18\/API-Request.png\" alt=\"\" width=\"1012\" height=\"463\" \/><\/a><\/p>\n<ul>\n<li><strong>Authorization<\/strong> &#8211; If required for your action task, you need to define the authorization to access the API, for example, using basic authorization, OAuth, or API Key. For more information, see <a href=\"#auth\">API Request Tab \u2013 Authorization Settings<\/a>.<\/li>\n<li><strong>WSDL URL<\/strong>\u00a0&#8211; 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. For more information, see <a href=\"#wsdl\">Defining the WSDL URL<\/a>.<\/li>\n<li><strong>Access Using a connector<\/strong>\u00a0&#8211; Specify if your Bots Platform is installed on-premise and if you want to user the Kore.ai Connector agent. For more information, see <a href=\"#access\">Access Using a Connector<\/a>.<\/li>\n<li><strong>Response Sample<\/strong> &#8211; Define key-value pairs that you expect to receive in the Action\u00a0task payload. The key-value pairs that you provide\u00a0are available as drop-down choices for handling the\u00a0data to display to the end-user. For more information, see <a href=\"#soap-response\">Adding a Response Sample for an Action Task<\/a>.<\/li>\n<\/ul>\n<p><\/div><br \/>\n<span class=\"collapseomatic \" id=\"wsdl\"  tabindex=\"0\" title=\"Defining the WSDL URL\"    >Defining the WSDL URL<\/span><div id=\"target-wsdl\" class=\"collapseomatic_content \"><\/p>\n<ol>\n<li>On the <strong>API Request<\/strong> tab, expand the <strong>WSDL URL<\/strong>\u00a0section<\/li>\n<li>To begin the request task configuration for a SOAP request, enter the URL for your SOAP WSDL in the <strong>WSDL URL<\/strong> field.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/WSDL-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14133\" src=\"\/wp-content\/uploads\/sites\/18\/WSDL-1.png\" alt=\"\" width=\"1057\" height=\"208\" \/><\/a><\/li>\n<li>Click <strong>Get WSDL Description<\/strong>. A\u00a0list of <strong>available operators<\/strong>\u00a0defined in the WSDL opens.<\/li>\n<li>Click Select\u00a0for the SOAP request that you want to use for your task. Kore.ai will automatically populate one or more Action Task Fields\u00a0if necessary for user input.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/WSDL-Selected.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14134\" src=\"\/wp-content\/uploads\/sites\/18\/WSDL-Selected.png\" alt=\"\" width=\"1069\" height=\"485\" \/><\/a><\/li>\n<\/ol>\n<h4><span class=\"wysiwyg-font-size-large\">Customizing\u00a0SOAP Action Task\u00a0Fields<\/span><\/h4>\n<p>You can customize the default input fields provided by Kore.ai after you select one or more of the available operations<strong>\u00a0<\/strong>from your WSDL.<br \/>\nTo customize the default Action Task\u00a0Fields, follow these steps<strong>:<\/strong><\/p>\n<ol>\n<li>Click <strong>Edit<\/strong> for the <strong>Action Task\u00a0Field<\/strong> that you want to customize.\u00a0The <strong>Setup Action Task\u00a0Field<\/strong>\u00a0dialog opens.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Edit-Task-Field.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14135\" src=\"\/wp-content\/uploads\/sites\/18\/Edit-Task-Field.png\" alt=\"\" width=\"644\" height=\"566\" \/><\/a><\/li>\n<li>To define the end-user fields to collect input, specify the values for the parameters in the <strong>Setup Action Task\u00a0Field<\/strong> dialog as described in the following table.<br \/>\n<table>\n<thead>\n<tr>\n<th>Field Name<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Field Title<\/td>\n<td>The title of the task input\u00a0field displayed in the end-user interface, for example, <span style=\"color: #0000ff\">Country.<\/span><\/td>\n<\/tr>\n<tr>\n<td>Help Hint<\/td>\n<td>The help text displayed below the task setting the title to describe the task, for example, <span style=\"color: #0000ff\">Enter the Country Name you want the Weather for.<\/span><\/td>\n<\/tr>\n<tr>\n<td>Field Key<\/td>\n<td>A read-only key that represents the end-user input value that you want to collect, for example, <span style=\"color: #0000ff\">country<\/span>.<\/td>\n<\/tr>\n<tr>\n<td>Field Type<\/td>\n<td>\n<p>Specifies the type of task input\u00a0field displayed in the end-user interface to collect user input for the request object to assign to the <strong>Key<\/strong> value. The default setting is <strong>Textbox<\/strong>, but can be customized to any one of the following:<\/p>\n<ul>\n<li><strong>Date<\/strong> &#8211; Displays the <strong>Format<\/strong> field where you can select the\u00a0date format syntax\u00a0for the end-user to define when the task\u00a0is configured for their account. In the <strong>Select Date Format<\/strong> drop-down list, select one of the following:\n<ul>\n<li><strong>dd-MM-YYYY<\/strong>\u00a0&#8211; For example,\u00a0<span style=\"color: #0000ff\">16-05-1999<\/span><\/li>\n<li><strong>MM-dd-YYYY<\/strong>\u00a0&#8211; For example,\u00a0<span style=\"color: #0000ff\">05-16-1999<\/span><\/li>\n<li><strong>dd-MM-YY<\/strong>\u00a0&#8211; For example,\u00a0<span style=\"color: #0000ff\">16-05-99<\/span><\/li>\n<li><strong>YYYY-MM-dd<\/strong> &#8211; For example,\u00a0<span style=\"color: #0000ff\">1999-05-16<\/span><\/li>\n<\/ul>\n<\/li>\n<li><strong>URL<\/strong> &#8211; Displays a text box for the end-user to enter a URL including field validation for a correct URL syntax. In the <strong>Placeholder<\/strong> field, enter the help hint displayed in the text box, for example, <span style=\"color: #0000ff\">Enter the URL for the website here.<\/span><\/li>\n<li><strong>Textbox<\/strong> &#8211; Displays a text box for the end-user to enter text as the task input field, typically just a few words. In the <strong>Placeholder<\/strong> field, enter the help hint displayed in the text field, for example, <span style=\"color: #0000ff\">Type\u00a0in the name you want to embroider.<\/span><\/li>\n<li><strong>Static Dropdown<\/strong> &#8211; Displays a drop-down list of choices to the end-user. Click <strong>Add Option<\/strong> to begin adding the list of items to display to the end-user with the following parameters:\n<ul>\n<li><strong>Option Name <\/strong>&#8211; The name of the option displayed to the end-user.<\/li>\n<li><strong>Option Value<\/strong> &#8211; The value the represents the <strong>Option Name<\/strong>\u00a0returned to the application.<\/li>\n<li><strong>Default Value<\/strong> &#8211; Select the default value for the option when more than one option is defined.<\/li>\n<li><strong>Searchable<\/strong> &#8211; Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.<\/li>\n<\/ul>\n<p>Click <strong>Save<\/strong>. To add additional items, click <strong>Add Option<\/strong> again. Edit or remove options in the <b>Actions<\/b> column for options.<\/li>\n<li><strong>Dynamic Dropdown<\/strong> &#8211; 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 <em>JIRA<\/em>\u00a0task notification. Define the following properties for a dynamically populated dropdown.\n<ul>\n<li><strong>Endpoint URL<\/strong> &#8211; The Bot\u00a0endpoint URL, for example,\u00a0<span style=\"color: #0000ff\">https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/li>\n<li><strong>Endpoint Content Type<\/strong> &#8211; The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, URL Encoded JSON, CCV, Text, or Twitter Encoded JSON.<\/li>\n<li><strong>Endpoint Method<\/strong> &#8211; One of:\n<ul>\n<li><strong>GET<\/strong> &#8211; Specifies an HTTP Request GET method for the task\u00a0field.<\/li>\n<li><strong>POST<\/strong> &#8211; Specifies an HTTP Request POST method for the task\u00a0field.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Response Path<\/strong> &#8211; The path in the response that contains the desired drop-down list values, for example, <span style=\"color: #0000ff\">data<\/span>.<\/li>\n<li><strong>Label Key<\/strong> &#8211; The key for the label of the drop-down option, for example, <span style=\"color: #0000ff\">name<\/span>.<\/li>\n<li><strong>Option Value Key<\/strong> &#8211; The key for the value of the drop-down option, for example, <span style=\"color: #0000ff\">id<\/span>.<\/li>\n<li><strong>Add Payload Field<\/strong> &#8211; Click to add one or more fields from the response payload as options for the dynamic dropdown. For each payload field, enter the <strong>Payload field key<\/strong> and the <strong>Payload field value<\/strong>, and then click <strong>Save<\/strong>. Edit or delete payload fields in the <strong>Actions<\/strong> column.<\/li>\n<li><strong>Searchable<\/strong> &#8211; Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<ul>\n<li><strong>Textarea<\/strong> &#8211; Displays a text area box for the end-user to enter text as the task\u00a0input, typically for several sentences. In the <strong>Placeholder<\/strong> field, enter the help hint displayed inside the text area.<\/li>\n<li><strong>Type Ahead<\/strong>\u00a0&#8211; 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\u00a0URL defined for the task. For example, a list of projects for a <em>JIRA<\/em>\u00a0task notification message. Define the following properties for a dynamically populated drop-down.\n<ul>\n<li><strong>Endpoint URL<\/strong> &#8211; The Bot\u00a0endpoint URL, for example,\u00a0<span style=\"color: #0000ff\">https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/li>\n<li><strong>Endpoint Content Type<\/strong> &#8211; 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.<\/li>\n<li><strong>Endpoint Method<\/strong> &#8211; One of:\n<ul>\n<li><strong>GET<\/strong> &#8211; Specifies an HTTP Request GET method for the task\u00a0field.<\/li>\n<li><strong>POST<\/strong> &#8211; Specifies an HTTP Request POST method for the task\u00a0field.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Response Path<\/strong> &#8211; The path in the response that contains the desired drop-down list values, for example, <span style=\"color: #0000ff\">data<\/span>.<\/li>\n<li><strong>Label Key<\/strong> &#8211; The key for the label of the drop-down option, for example, <span style=\"color: #0000ff\">name<\/span>.<\/li>\n<li><strong>Option Value Key<\/strong> &#8211; The key for the value of the drop-down option, for example, <span style=\"color: #0000ff\">id<\/span>.<\/li>\n<li><strong>Add Payload Field<\/strong> &#8211; Click to add one or more fields from the response payload as options for the type ahead field. For each type ahead field option, enter the <strong>Payload field key<\/strong> and the <strong>Payload field value<\/strong>, and then click <strong>Save<\/strong>. Edit or delete payload fields in the <strong>Actions<\/strong> column.<\/li>\n<li><strong>Editable<\/strong> &#8211; Enables the end-user to enter text free-from in the field as an option when type-ahead search results do not match.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Email<\/strong> &#8211; Displays a text box for the end-user to input\u00a0an email address. In the <strong>Placeholder<\/strong> field, enter the help hint to display to the end-user inside\u00a0the text box.<\/li>\n<li><strong>Date &amp; Time<\/strong> &#8211; Displays a text box for the end-user to input\u00a0a date with\u00a0time. In the <strong>Format<\/strong> field, enter the expected date or time format to display to the end-user in the date text box. In the <strong>Select Date Format<\/strong> drop-down list, select the date with\u00a0time format.<\/li>\n<li><strong>Time Zone<\/strong> &#8211; Displays a drop-down list of time zones based on the operating system settings.<\/li>\n<li><strong>Location<\/strong> &#8211; Displays a text box for the end-user to enter a geographical location, for example, <span style=\"color: #0000ff\">Orlando, FL<\/span>, or <span style=\"color: #0000ff\">32801<\/span>.<\/li>\n<li><strong>Nested Form<\/strong> &#8211; Displays end-user input fields in a nested format below the parent input field. Specify the following fields for a nested form input field:\n<ul>\n<li><strong>Array Element\u00a0Type<\/strong> &#8211; Select\u00a0the data type of the parent input form element.<\/li>\n<li><strong>Add Nested Form Field<\/strong> &#8211; Click to add one or more nested form fields.<\/li>\n<\/ul>\n<\/li>\n<li><strong>File Upload<\/strong> &#8211; Displays end-user control to search for, and select a file to upload. When clicked, enter the <strong>File Upload Payload Key<\/strong>. When the <strong>File Upload Payload Key<\/strong> is defined, in the <strong>File Upload Payload Field Value<\/strong> drop-down list, select one of the following types:\n<ul>\n<li><strong>File Name<\/strong><\/li>\n<li><strong>File Size<\/strong><\/li>\n<li><strong>File Content Type<\/strong><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Data Type<\/td>\n<td>\n<p>Select one of these user input types:<\/p>\n<ul>\n<li><strong>String<\/strong> &#8211; Users can input any sequence of numbers, letters, or special characters.<\/li>\n<li><strong>Number<\/strong> &#8211; Users can input a number. No special characters are allowed.<\/li>\n<li><strong>Boolean<\/strong> &#8211; User can input a Boolean value of <span style=\"color: #0000ff\">true<\/span> or <span style=\"color: #0000ff\">false<\/span>.<\/li>\n<li><strong>Email<\/strong> &#8211; User can input a valid email address.<\/li>\n<li><strong>Object<\/strong> &#8211; Data from a Bot\u00a0can be received as JSON objects, for example, as location details defined as:<br \/>\n<span style=\"color: #0000ff\">\u00a0&#8220;location&#8221; : {<br \/>\n<\/span><span style=\"color: #0000ff\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0&#8220;lat&#8221; : 17.4374614,<br \/>\n<\/span><span style=\"color: #0000ff\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0&#8220;lng&#8221; : 78.4482878<\/span><br \/>\n<span style=\"color: #0000ff\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span><br \/>\nwhere you can refer to the properties in a request chain or task\u00a0request as <span style=\"color: #0000ff\">location.lat<\/span>, and <span style=\"color: #0000ff\">location.lng<\/span>.<\/li>\n<li><strong>Array<\/strong> &#8211; Users can pass a comma-separated list of values to the Bot. For example, in <em>Google Calendar<\/em>, multiple attendees with data can be passed as:<br \/>\n<span style=\"color: #0000ff\">&#8220;attendees&#8221;: [&#8220;user1&#8221;, &#8220;user2&#8221;, &#8220;user3&#8221;]<br \/>\n<\/span>When selected, specify the <strong>Type<\/strong> for the array of end-user input as one of:<\/p>\n<ul>\n<li><strong>String<\/strong><\/li>\n<li><strong>Number<\/strong><\/li>\n<li><strong>Boolean<\/strong><\/li>\n<li><strong>Email<\/strong><\/li>\n<li><strong>Array<\/strong><\/li>\n<li><strong>Date<\/strong><\/li>\n<\/ul>\n<\/li>\n<li><strong>Date<\/strong> &#8211; Users can type a complete date or select <span style=\"background-color: #f6d5d9\">it\u00a0<\/span>from a date picker.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Placeholder<\/td>\n<td>The text displayed below the input textbox to help the user define the field. This field is only displayed for some <strong>Field Types<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>Visibility<\/td>\n<td>Specify if the task input\u00a0field should be visible or hidden from the end-user.<br \/>\nThe <strong>Visibility<\/strong> field can also be set to <strong>Custom<\/strong> field where data is captured from the user but not used as a query parameter or payload field. For example, with a <i>JIRA<\/i> bot, posting a comment on a ticket using an <span style=\"color: #0000ff\">@mention<\/span> tag as shown below:<br \/>\n<span style=\"color: #0000ff\">&#8220;@Mike, please look into this issue&#8221;<\/span><br \/>\nThe <i>JIRA<\/i> API to <i>Post a comment<\/i> requires one query field and one payload field as:<\/p>\n<ul>\n<li>Issue ID<\/li>\n<li>Comment<\/li>\n<\/ul>\n<p>With the <strong>Visibility<\/strong> field set to <strong>Custom<\/strong>, you can capture the user information for the user mentioned as <code>@Mike<\/code> using the <i>JIRA<\/i> API to fetch data to append to the <code>comment<\/code> field value, but not to use as payload field or query field.<br \/>\nThe default <strong>Visibility<\/strong> field setting is <strong>Visible<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>Mandatory<\/td>\n<td>Select if the\u00a0end-user must define this setting to save the task\u00a0settings configuration.<\/td>\n<\/tr>\n<tr>\n<td>Untranspose the Key<\/td>\n<td>Select to disable key transposition by Kore.ai. By default, Kore.ai transposes a key\/value pair, for example, <code>\"parameter\":\"value\"<\/code> is transposed by Kore.ai to <code>\"parameter:{value:\"actualValue\"}<\/code>. When selected, keys are not transposed by Kore.ai and passed in the response as received.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>Click <strong>Add &amp; Continue<\/strong>\u00a0to save the task\u00a0field and create another <strong>Action Task Field.\u00a0<\/strong>Or, click\u00a0<strong>Add &amp; Exit<\/strong>\u00a0to save the\u00a0<strong>Action Task Field<\/strong> and then close the dialog.<\/li>\n<\/ol>\n<p><\/div><br \/>\n<span class=\"collapseomatic \" id=\"access\"  tabindex=\"0\" title=\"Access Using a Connector\"    >Access Using a Connector<\/span><div id=\"target-access\" class=\"collapseomatic_content \"><br \/>\nTo get started with defining access using a connector\u00a0for a task, follow these steps:<\/p>\n<ol>\n<li>On the <strong>API Request<\/strong> tab, expand the <strong>Access using a connector<\/strong>\u00a0section.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Access-using-a-connector.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14139\" src=\"\/wp-content\/uploads\/sites\/18\/Access-using-a-connector.png\" alt=\"\" width=\"1059\" height=\"217\" \/><\/a><\/li>\n<li>In the<strong> Access Using A Connector<\/strong>\u00a0field, select <strong>Yes<\/strong> 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 <a href=\"\/v8-1\/docs\/bots\/admin-console\/security-control\/security-module-overview\/#Why_Use_the_Koreai_Connector_for_Bots\">Using the Kore.ai Connector<\/a>.<\/li>\n<\/ol>\n<p><\/div><br \/>\n<span class=\"collapseomatic \" id=\"soap-response\"  tabindex=\"0\" title=\"Adding a Response Sample\"    >Adding a Response Sample<\/span><div id=\"target-soap-response\" class=\"collapseomatic_content \"><br \/>\nIn the <strong>Response Sample<\/strong>\u00a0section, you can enter or paste examples of the key-value pairs that you expect to receive in the task payload.\u00a0When you define the response sample, the keys specified\u00a0in the\u00a0<strong>Response Sample<\/strong>\u00a0section are available as drop-down choices for handling the\u00a0output data.<\/p>\n<h4>Adding the Sample Response<\/h4>\n<ol>\n<li>On the <strong>API Request<\/strong> tab, Expand the <strong>Sample Response<\/strong> section.<\/li>\n<li>Enter your Response Sample that contains the key-value pairs from your JSON response payload. Do one of the following:\n<ul>\n<li>To format the view of the response as a JSON structure with indentation as shown in the following\u00a0illustration, click the <strong>Formatted<\/strong> <img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-9801 size-full\" src=\"\/wp-content\/uploads\/sites\/18\/DIYFormattedIcon.png\" width=\"26\" height=\"26\" \/>\u00a0icon.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Sample-response-indent.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14126\" src=\"\/wp-content\/uploads\/sites\/18\/Sample-response-indent.png\" alt=\"\" width=\"1051\" height=\"389\" \/><\/a><\/li>\n<li>To format the view of the response in serialized compact form as shown in the following illustration, click the <strong>Unformatted <img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-9802 size-full\" src=\"\/wp-content\/uploads\/sites\/18\/DIYUnFormattedIcon.png\" width=\"26\" height=\"26\" \/><\/strong>\u00a0icon.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p><\/div><br \/>\n<\/div>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3><span class=\"ez-toc-section\" id=\"Step_4_Defining_the_Bot_Response\"><strong>Step 4:<\/strong> \u00a0Defining the Bot Response<\/span><\/h3>\n<p>The Bot response provides a message to the end-user to inform the end-user of the status or completion of the task. On the <strong>Bot Response<\/strong> tab for a task, you can define the message to display to the end-user from the API request payload. You can define a default response for all channels, and optionally define channel-specific messages.<\/p>\n<p>After you describe your Bot alert task <strong>General<\/strong> tab settings and then configure the alert task <strong>API request chain<\/strong>, you are ready to define how the alert task results are displayed to the end-user. This section describes how to configure an <strong>alert task response<\/strong>.<br \/>\nTo define the response object for an alert task, there are two\u00a0sections:<\/p>\n<ul>\n<li><strong>Report Template Definition<\/strong> &#8211; For some tasks, you may want to display report data to the end-user as a link that can display the payload response using a template, such as a table, contact card, or formatted for a specific message type such as a weather report.\n<p class=\"note\"><strong>Note:<\/strong> This section is not used for webhook alert tasks, action tasks, or RSS alert tasks.<\/p>\n<p><span class=\"collapseomatic \" id=\"report\"  tabindex=\"0\" title=\"Configuring the Report Template Definition\"    >Configuring the Report Template Definition<\/span><div id=\"target-report\" class=\"collapseomatic_content \"><br \/>\nTo add a link to a task to provide more information or a report, you can define <strong>a link<\/strong> and information to display for the report as a table, weather report, or contact card in the end-user application.<br \/>\nTo get started with defining the<b>\u00a0Report Template Definition<\/b>\u00a0for a\u00a0task, on the<strong> Bot Response<\/strong>\u00a0tab, click the <strong>Expand<\/strong> icon in the<b> (Optional) Report Template Definition<\/b>\u00a0section as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYAlertTaskBotResponseTabReportSection.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-19542\" src=\"\/wp-content\/uploads\/sites\/18\/DIYAlertTaskBotResponseTabReportSection.png\" alt=\"\" width=\"820\" height=\"461\" \/><\/a><br \/>\nTo enable a report link for the task, select\u00a0<strong>Yes<\/strong> to display the <strong>Report Template\u00a0<\/strong><b>Definition<\/b>\u00a0section shown in the previous\u00a0illustration.<br \/>\nWhen you add a link to a task response message, the end-user for the Bot has the ability to select the link and get more details, such as a table of values for <em>Closed Sales Opportunities<\/em> in the\u00a0<em>SalesForce<\/em>\u00a0Bot.<br \/>\nDefine the following parameters to create a link in a task response message\u00a0for the end-user to request a report for additional information from the initial task response message:<\/p>\n<ul>\n<li><strong>Link Title<\/strong> \u2013 The link text displayed to the end-user in the task post, for example, <span style=\"color: #0000ff\"><em>View Shopping Cart<\/em><\/span>.<\/li>\n<li><strong>Header<\/strong> \u2013 The title displayed\u00a0when the report is displayed to the end-user, for example, <em><span style=\"color: #0000ff\">These are the items in your Shopping Cart<\/span><\/em>.<\/li>\n<li><strong>Details<\/strong> \u2013 End-user help information displayed directly below the Header in the report that describes the content of the report, for example, <span style=\"color: #0000ff\"><em>Review your Shopping Cart<\/em><\/span>, and then click <strong>Continue<\/strong> when you are ready to place your order.<\/li>\n<li><strong>Template<\/strong> \u2013 Select one of the following\u00a0format templates to display the data from the task response. For each type, define the <strong>Column Name<\/strong>, <strong>Key Mapping<\/strong>, <strong>Data Type<\/strong>, and template-specific options.\n<ul>\n<li><strong>Table<\/strong> &#8211; Data is presented in a table format with defined columns. Each mapping for the\u00a0<strong>Table<\/strong>\u00a0template can be set to <strong>Is Sortable<\/strong>, <strong>Display as an image<\/strong>, and\u00a0<strong>Display it as a link<\/strong>.\u00a0For more information, see <a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-table-report\/\">Defining a Table Report<\/a>.<\/li>\n<li><strong>Fixed Column Table<\/strong> &#8211;\u00a0Data is presented in a table format with\u00a0the one or more\u00a0columns fixed.\u00a0Each mapping for the <strong>Fixed Column Table<\/strong> template can be set to <strong>Is Sortable<\/strong>, <strong>Column in fixed<\/strong>,\u00a0<strong>Display as an image<\/strong>\u00a0and\u00a0<strong>Display it as a link<\/strong>.\u00a0For more information, see <a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-fixed-column-table-report\/\">Defining a Fixed-Column Table Report<\/a>.<\/li>\n<li><strong>Card Layout<\/strong> &#8211; Data is presented in a contact card format.\u00a0Each mapping for the\u00a0<strong>Card Layout<\/strong>\u00a0template can be set to <strong>Is Sortable<\/strong>, <strong>Display as an image<\/strong>, and\u00a0<strong>Display it as a link<\/strong>.\u00a0For more information, see <a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-card-layout-report\/\">Defining a Card Layout Report<\/a>.<\/li>\n<li><strong>Weather Info<\/strong> &#8211; Date for a weather service response payload can be defined.\u00a0Each mapping for the\u00a0<strong>Weather Info<\/strong>\u00a0template can be set to <strong>Is Sortable<\/strong>,\u00a0<strong>Display as an image<\/strong>, and\u00a0<strong>Display it as a link<\/strong>.\u00a0For more information, see <a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/defining-a-weather-info-report\/\">Defining a Weather Info Report<\/a>.<\/li>\n<li><strong>Card Layout with Actions<\/strong> \u2013 Displays a list of items with a mapped task link for each item.\u00a0For more information, see <a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/define-a-card-layout-with-actions-report\/\">Define a Card Layout with Actions Report<\/a>.<\/li>\n<li><strong>Card Layout with Group By<\/strong> \u2013 Displays a list of items grouped by a specific field.\u00a0For more information, see <a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/define-a-card-layout-with-group-by-report\/\">Define a Card Layout with Group By Report<\/a>.<\/li>\n<li><strong>Shopping Cart Layout with Actions<\/strong> \u2013\u00a0Displays a list of items with a mapped task link for each item.\u00a0For more information, see <a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/develop\/simple-task\/information-tasks\/define-a-shopping-cart-layout-with-actions-report\/\">Define a Shopping Cart Layout with Actions Report<\/a>.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><\/div><\/li>\n<li><strong>Message Definition<\/strong> &#8211; In this section, you define the look and feel of the data presented to the end-user when the alert is displayed based on the payload delivered by the webhook.<br \/>\n<span class=\"collapseomatic \" id=\"message\"  tabindex=\"0\" title=\"Defining the Message Definition\"    >Defining the Message Definition<\/span><div id=\"target-message\" class=\"collapseomatic_content \"><br \/>\nYou can define two kinds of bot responses for a task:<\/p>\n<ul>\n<li><strong>The default for all channels:<\/strong>\u00a0Author the default title and message response for all channels based on the payload response from the API request and any processors defined.\u00a0You can create a mixture of data from the\u00a0response object along with your\u00a0own inputs, a set of <strong>Variable Keys<\/strong> derived from the Kore.ai system, custom variables, and the response sample.\u00a0The message is displayed as a message, usually as a well-formed HTML message that contains one or more variables, such as the ID number or subject, from the request object data.<\/li>\n<li><strong>Channel-specific response:<\/strong>\u00a0You can also customize a Bot response message for specific channels, for example, Facebook Messenger, Skype, SMS, or Web\/Mobile SDK, along with applying predefined message templates (tables, lists, graphs, etc.) for selected channels.<\/li>\n<\/ul>\n<h5>Message Definition Editor Features<\/h5>\n<p>To open the editor for your Action task, go to <strong>Bot Response &gt;<\/strong>\u00a0<b>Message Definition<\/b>. The Message Definition editor uses three tabs to offer the following features:<\/p>\n<ul>\n<li><strong>Standard Text<\/strong>: Use basic editor controls and HTML markup, and variable keys to define and format the response. Enter text, and then format it using buttons for bold, italics, header styles, hyperlinks, ordered and unordered lists, and inserting lines.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Standard-text.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14145\" src=\"\/wp-content\/uploads\/sites\/18\/Standard-text.png\" alt=\"\" width=\"1040\" height=\"464\" \/><\/a><\/li>\n<li><strong>JavaScript<\/strong>: Add custom code to handle the end-user task response message, declare variables, use variable keys, and interact with third-party applications.<\/li>\n<li><strong>Preview<\/strong>: View a sample of the rendered output message, with markup, as the bot users see it.<\/li>\n<\/ul>\n<h5>Adding Variable\u00a0Keys<\/h5>\n<p>Follow these steps to add variable keys:<\/p>\n<ol>\n<li>Whether you are using Standard Text or JavaScript mode, to add a variable key, place the cursor where you want to add the variable and then click <strong>Variable\u00a0Keys<\/strong>.<\/li>\n<li>In the <strong>Request\/Response Keys<\/strong> dialog, expand the type of key node that contains the variable you want to insert.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Request-Response.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14147\" src=\"\/wp-content\/uploads\/sites\/18\/Request-Response.png\" alt=\"\" width=\"928\" height=\"329\" \/><\/a><\/li>\n<li>Select the variable that you want to add, for example, <code>response.data.id<\/code>and then click <strong>Ok<\/strong>,<\/li>\n<\/ol>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYBotResponseKeys.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9813\" src=\"\/wp-content\/uploads\/sites\/18\/DIYBotResponseKeys.png\" alt=\"Bot Response Tab Message Definition Keys\" width=\"593\" height=\"525\" \/><\/a><\/p>\n<h6>Standard Keys<\/h6>\n<p><strong>Standard Keys<\/strong> are the following Kore.ai variable placeholders for reusable data.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Standard-keys.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14148\" src=\"\/wp-content\/uploads\/sites\/18\/Standard-keys.png\" alt=\"\" width=\"927\" height=\"414\" \/><\/a><\/p>\n<ul>\n<li><strong>_labels _<\/strong>: Returns the friendly label in place of a GUID. For example, when user data is requested from a web service API, the ID of a project or workspace returned is a GUID. You can use the\u00a0<code>_labels_<\/code> key to show the user-friendly name of the GUID to the end-user instead of the GUID. In Kore.ai, a drop-down control stores the response for the\u00a0<code>_labels_<\/code> key as, for example:\n<pre class=\"lang:default decode:true\">{\r\n    \"_labels_\": {\r\n        \"15379386734832\": \"roadlabs.com\",\r\n        \"26377329985341\": \"Test Project\",\r\n        \"workspace\": \"roadlabs.com\",\r\n        \"project\": \"Test Project\"\r\n    },\r\n    \"_fields_\": {\r\n        \"workspace\": \"15379386734832\",\r\n        \"project\": \"26377329985341\"\r\n    }\r\n}<\/pre>\n<p>To use the <code>_labels_<\/code> key in a response:<\/p>\n<pre class=\"lang:default decode:true\">print('&lt;a href=\"https:\/\/app.asana.com\/0\/' + workspace.id + '+_labels_[workspace.id]);<\/pre>\n<\/li>\n<li><strong>_tenant_<\/strong> &#8211; Returns the tenant for the enterprise when defined. For example, <em>JIRA<\/em> requires a tenant for URLs, such as <span style=\"color: #0000ff\">koreteam<\/span>, in\u00a0<span style=\"color: #0000ff\">https:\/\/<strong>koreteam<\/strong>.atlassian.net\/browse\/BBF-3265<\/span>. You can use the <code>_tenant_<\/code> key to build a link in a task response such as:\n<pre class=\"lang:default decode:true\">var title = request.fields.issuetype.name + ' &lt;a href =\"https:\/\/' + _tenant_ + '\/browse\/' + response.key + '\" target = \"_blank\"&gt;' + request.fields.summary + '&lt;\/a&gt; \u00a0has been created.';<\/pre>\n<\/li>\n<li><strong>_fields_<\/strong> &#8211; Used to return a task field input provided by the end-user that is not part of a payload response. For example, in a <em>JIRA<\/em>\u00a0task, the end-user is prompted to enter a workspace name. You can use the <code>_fields_<\/code> key to store the end-user input as:\n<pre class=\"lang:default decode:true\">_fields_[\"workspace\"]<\/pre>\n<\/li>\n<li><strong>_last_run<\/strong> &#8211; Used to return the UTC date timestamp of a web service poll using ISO 8601 format, for example,\u00a02016-03-05T12:44:38+00:00. For example, if a web service request returns all activity in a payload response, you can use the <code>_last_run<\/code> key to filter results displayed before or after the value for<code>_last_run<\/code><\/li>\n<\/ul>\n<h6>Session Keys<\/h6>\n<p><strong>Session Keys<\/strong>\u00a0are Kore.ai variable placeholders for user data specific to a single session instance.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYBotResponseVariableSessionKeys.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-10221\" src=\"\/wp-content\/uploads\/sites\/18\/DIYBotResponseVariableSessionKeys.png\" alt=\"Session Keys\" width=\"599\" height=\"444\" \/><\/a><\/p>\n<ul>\n<li><strong>UserContext.get(&#8220;_id&#8221;)<\/strong> &#8211;\u00a0The Kore.ai userId.<\/li>\n<li><strong>UserContext.get(&#8220;emailId&#8221;)<\/strong> &#8211;\u00a0The email address associated with the userId.<\/li>\n<li><strong>UserContext.get(&#8220;lastName&#8221;)<\/strong> &#8211;\u00a0The last name of the user.<\/li>\n<li><strong>UserContext.get(&#8220;firstName&#8221;)<\/strong> &#8211;\u00a0The first name of the user.<\/li>\n<li><strong>UserContext.get(&#8220;profImage&#8221;)<\/strong> &#8211;\u00a0The image or avatar filename of the user.<\/li>\n<li><strong>UserContext.get(&#8220;profColor&#8221;)<\/strong> &#8211;\u00a0The account color for the user.<\/li>\n<li><strong>UserContext.get(&#8220;activationStatus&#8221;)<\/strong> &#8211;\u00a0The account status of the user.<\/li>\n<li><strong>UserContext.get(&#8220;jTitle&#8221;)<\/strong> &#8211;\u00a0The title of the user, if defined.<\/li>\n<li><strong>UserContext.get(&#8220;orgId&#8221;)<\/strong> &#8211;\u00a0The organizational ID of the user account, if defined.<\/li>\n<li><strong>UserContext.get(&#8220;customData&#8221;)<\/strong> &#8211; A developer defined custom key.<\/li>\n<li><strong>UserContext.get(&#8220;identities&#8221;)<\/strong> &#8211; Alternate user IDs, if defined.<\/li>\n<\/ul>\n<p>Additional session keys may be available depending on how the Bot task is defined and the context of keys available for that task.\u00a0For more information about session and context keys, see <a href=\"\/v8-1\/docs\/bots\/bot-builder-tool\/dialog-task\/using-session-and-context-variables-in-tasks\/\">Using Session and Context Variables in Tasks<\/a>.<\/p>\n<h6>Response Keys<\/h6>\n<p>Response Keys are parsed directly from your <strong>Response Sample<\/strong>\u00a0text in the\u00a0<strong>API Response<\/strong>\u00a0tab. Response Keys\u00a0vary depending on the Response Sample defined.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYBotResponseVariableResponseKeys.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-10222\" src=\"\/wp-content\/uploads\/sites\/18\/DIYBotResponseVariableResponseKeys.png\" alt=\"Response Keys\" width=\"593\" height=\"523\" \/><\/a><br \/>\nThe following list is an example of Response Keys available for an <em>Asana<\/em> task.<\/p>\n<pre class=\"lang:default decode:true\">request.data.workspace\r\nrequest.data.projects\r\nrequest.data.name\r\nrequest.data.notes\r\nlabels.498346170860\r\nlabels.30887755353556\r\nlabels[\"data.workspace\"]\r\nlabels[\"data.projects\"]\r\n_tenant_\r\nresponse.data.id\r\nresponse.data.created_at\r\nresponse.data.modified_at\r\nresponse.data.name\r\nresponse.data.notes\r\nresponse.data.completed\r\nresponse.data.assignee_status\r\nresponse.data.completed_at\r\nresponse.data.due_on\r\nresponse.data.due_at\r\nresponse.data.workspace.id\r\nresponse.data.workspace.name\r\nresponse.data.num_hearts\r\nresponse.data.parent\r\nresponse.data.followers[0].id\r\nresponse.data.followers[0].name\r\nresponse.data.hearted\r\nresponse.data.assignee\r\nresponse.data.projects[0].id\r\nresponse.data.projects[0].name\r\nresponse.data.memberships[0].project.id\r\nresponse.data.memberships[0].project.name\r\nresponse.data.memberships[0].section<\/pre>\n<h6>Report\u00a0Keys<\/h6>\n<p>Report Keys are Kore.ai variable placeholders that you can use in Report Template Definitions and Bot Responses to show links for additional information in a message that a user can click.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYBotResponseVariableReportKeys.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-10223\" src=\"\/wp-content\/uploads\/sites\/18\/DIYBotResponseVariableReportKeys.png\" alt=\"Report Keys\" width=\"593\" height=\"526\" \/><\/a><\/p>\n<ul>\n<li><strong>reportInfo.reportLink<\/strong>\u00a0&#8211;\u00a0The\u00a0link defined in the <strong>Report Template Definition<\/strong>\u00a0section for this task.<\/li>\n<li><strong>reportInfo.reportTitle<\/strong>\u00a0&#8211;\u00a0The title defined in the <strong>Report Template Definition<\/strong> for this task.<\/li>\n<\/ul>\n<h5>Previewing the Response<\/h5>\n<p>On the message editor, click <strong>Preview<\/strong> to generate a preview of your response using one of\u00a0the following options:<\/p>\n<ul>\n<li><strong>Test &amp; Preview<\/strong> &#8211; Opens the task setup page for your Bot to define the task settings, authenticate, and then shows a preview of your response generated through your third-party web service, for example, <em>Asana<\/em>.<\/li>\n<li><strong>Preview with sample response<\/strong> &#8211; Generates the preview using the sample data provided\u00a0with the key-value pairs defined in the\u00a0<strong>Response Sample<\/strong> section on the <strong>API Request<\/strong> tab for the task.<\/li>\n<\/ul>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/preview.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14151\" src=\"\/wp-content\/uploads\/sites\/18\/preview.png\" alt=\"\" width=\"1010\" height=\"219\" \/><\/a><\/p>\n<h5>Examples of Custom JavaScript Response<\/h5>\n<p>The following examples show response objects using JavaScript to define the <strong>Post Title<\/strong> and <strong>Post Description<\/strong>\u00a0sections that display output messages to the end-user when the task response message is sent.<br \/>\nIn the following example, the variable labeled <span style=\"color: #0000ff\">desc<\/span> is only displayed if the value for the caption is defined in the JSON response.<\/p>\n<pre class=\"\">var desc = (caption !== \"undefined\" ? caption : \"\")<\/pre>\n<p>In the next example, a clickable URL using the task <span style=\"color: #0000ff\">title<\/span> is displayed in the task response message.<\/p>\n<pre class=\"\">var tasklink = '<a href=\"https:\/\/www.wunderlist.com\/webapp#\/tasks\/' + id + '\" target=\"_blank\" rel=\"noopener noreferrer\">' + title + '<\/a>';<\/pre>\n<p>In this last example, the link variable depends on the <span style=\"color: #0000ff\">type<\/span>, either <span style=\"color: #0000ff\">video<\/span> or <span style=\"color: #0000ff\">photo<\/span>. Based on the\u00a0<span style=\"color: #0000ff\">type<\/span>, the proper link is displayed.<\/p>\n<pre class=\"toolbar:1 lang:default decode:true\">var link = \"\";\r\nswitch (type) {\r\n    case \"video\":\r\n        var video = (typeof(video_url) != \"undefined\") ? video_url : permalink_url;\r\n        link = '&lt;video controls&gt;&lt;source src =\"' + video + '\" type=\"video\/mp4\"&gt;&lt;\/video&gt;';\r\n        break;\r\n    case \"photo\":\r\n        link = '&lt;img src=\"' + image_permalink + '\"&gt;&lt;\/img&gt;';\r\n        break;\r\n}<\/pre>\n<p>You can create custom JavaScript to handle task-specific requirements on the <strong>JavaScript <\/strong>tab based on\u00a0the payload response for the task.<\/p>\n<h4>Channel-Specific\u00a0Bot Response<\/h4>\n<p>A task response message may be dependent on the channel that the response message is displayed in, for example, in the Kore.ai Messenger client, an email, or in a text message. By default, the response message that you configure for <strong>Default for all Channels<\/strong>\u00a0is sent to all channels. However, you can define a specific response for one or more or the 20+ supported channels to display to the end-user in that channel instead of the default\u00a0response.<\/p>\n<ol>\n<li>To define the\u00a0response message for a specific channel, click <span style=\"color: #33cccc\"><strong>+ Add Channel<\/strong><\/span> to display the <strong>Choose a Channel<\/strong> drop-down list.<\/li>\n<li>Select a channel, for example, <strong>Kore.ai<\/strong>, and then configure the response for that channel on the <strong>JavaScript<\/strong>\u00a0tab.<\/li>\n<\/ol>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/bot-response-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14149\" src=\"\/wp-content\/uploads\/sites\/18\/bot-response-1.png\" alt=\"\" width=\"1024\" height=\"530\" \/><\/a><br \/>\nOnly one response can be defined for each channel. The following JavaScript examples show how you can override the Kore.ai default formatting template by channel.<\/p>\n<p class=\"note\"><strong>Note:<\/strong>\u00a0Use the following keys to return default values for:<br \/>\n<span style=\"color: red;font-family: courier\">response.message<\/span> &#8211; Returns the default message as a string.<br \/>\n<span style=\"color: red;font-family: courier\">response.message.choices<\/span> &#8211; Returns the options choice or confirmation message types as an array.<\/p>\n<ul>\n<li><strong>Slack Channel Override Example<\/strong>\n<pre class=\"lang:default decode:true\">var message = {};\r\nvar attachments = [];\r\nvar attachment = {\r\n    'text': \"Exception occurred during API execution\",\r\n    'color': '#FFCC00',\r\n    'attachment_type': 'default'\r\n};\r\nattachments.push(attachment);\r\nmessage.attachments = attachments;\r\nprint(JSON.stringify(message));<\/pre>\n<\/li>\n<li><strong>FaceBook Channel Override Example<\/strong>\n<pre class=\"lang:default decode:true \">var message = {\r\n    text: response.message\r\n};\r\nvar buttons = [];\r\nfor (var i = 0; i &lt; response.choices.length; i++) {\r\n    var choiceItem = response.choices[i];\r\n    if (choiceItem.length &gt; 20) {\r\n        choiceItem = choiceItem.substring(\r\n            0, 18) + '..';\r\n    }\r\n    var element = {\r\n        content_type: 'text',\r\n        title: choiceItem,\r\n        payload: choiceItem\r\n    };\r\n    buttons.push(element);\r\n}\r\nmessage.quick_replies = buttons;\r\nprint(JSON.stringify(message));<\/pre>\n<\/li>\n<li><strong>Email Channel Override Example<\/strong>\n<pre class=\"lang:default decode:true \">var message = {};\r\nvar text = response.message + ' &lt;br&gt; ';\r\nfor (var i = 0; i &lt; response.choices.length; i++) {\r\n    text = text.concat(\r\n        '&lt;u&gt; + response.choices[i] + ' &lt;\r\n        \/u&gt; &lt;br&gt;');\r\n    }\r\n    message.text = text;\r\n    print(JSON.stringify(message));<\/pre>\n<\/li>\n<li><strong>SMS Channel Override Example<\/strong>\n<pre class=\"lang:default decode:true \">var message = {};\r\n    var indexArray = ['a', 'b', 'c',\r\n        'd', 'e',\r\n        'f', 'g', 'h', 'i', 'j',\r\n        'k', 'l', 'm', 'n', 'o',\r\n        'p', 'q', 'r', 's', 't',\r\n        'u', 'v', 'w', 'x', 'y',\r\n        'z'\r\n    ];\r\n    var text = response.message + '\\\\n';\r\n    for (var i = 0; i &lt; response.choices\r\n        .length; i++) {\r\n        text = text.concat(indexArray[i] +\r\n            ') ' + response.choices[\r\n                i] + '\\\\n');\r\n    }\r\n    message.text = text;\r\n    print(JSON.stringify(message));<\/pre>\n<\/li>\n<\/ul>\n<p><\/div><\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Starting Release 8.0.0, Information Tasks are no longer supported. This feature will be discontinued in the upcoming releases. We recommend using the Dialog Tasks and Digital Forms to build these use-cases \ufeff Information tasks are used by chatbots to look up data or pull reports for users and return easy-to-consume results or a link to...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[38],"tags":[],"class_list":["post-17812","post","type-post","status-publish","format-standard","hentry","category-action-info-task"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/17812","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/comments?post=17812"}],"version-history":[{"count":12,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/17812\/revisions"}],"predecessor-version":[{"id":27077,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/17812\/revisions\/27077"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/media?parent=17812"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/categories?post=17812"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/tags?post=17812"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}