{"id":17682,"date":"2016-06-01T19:47:20","date_gmt":"2016-06-01T18:47:20","guid":{"rendered":"http:\/\/apidocs.kore.com\/docs\/bot-builder\/kore-bot-alert-tasks\/"},"modified":"2021-03-30T12:53:28","modified_gmt":"2021-03-30T11:53:28","slug":"notification-tasks","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v7-1\/docs\/bots\/bot-builder-tool\/alert\/notification-tasks\/","title":{"rendered":"Alert 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<p>Alert tasks deliver timely, relevant, and personalized information from enterprise systems to customers and employees by polling the relevant service in real-time or according to a user-defined schedule. These alerts can contain detailed information, such as name, ID, notes, amount, and more, in a variety of formats for each channel.<\/p>\n<h4>Key Features<\/h4>\n<ul>\n<li><strong>Scheduled Alerts<\/strong>: Users can schedule alerts to trigger according to the days, times, and frequencies they specify.<\/li>\n<li><strong>Filtered Alerts: <\/strong>Users can configure alerts to trigger when certain thresholds are met such as amounts, dates, text matches, and more.<\/li>\n<\/ul>\n<h4>Example Use Cases<\/h4>\n<p>The following are a few sample use cases for Alert tasks:<\/p>\n<ul>\n<li>A time or location-based promotional offers<\/li>\n<li>Scheduled delivery updates<\/li>\n<li>Inventory level changes<\/li>\n<li>Critical issue notification<\/li>\n<li>Pandemic or weather-related awareness<\/li>\n<li>Cross-company status changes<\/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=\"Configuring\">Configuring<\/span><\/h2>\n<p>To configure an Alert task, you need to complete the following settings:<\/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<h3 id=\"general\"><span class=\"ez-toc-section\" id=\"General_Settings\">General Settings<\/span><\/h3>\n<p>The first step is to define how the task looks to the end-user. The General tab Settings includes details such as task name, connection mode, descriptions, and a few advanced settings such as task demo, search keywords, etc..<\/p>\n<ol>\n<li>Open the bot in which you want to create the Alert Task.<\/li>\n<li>Hover over the side navigation panel of the bot, and click <strong>Bot Tasks<\/strong>.<\/li>\n<li>On the Bot Tasks page, hover over the <strong>Alert Task<\/strong> tab and click the plus icon.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/task-type.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-14169\" src=\"\/wp-content\/uploads\/sites\/12\/task-type.png\" alt=\"\" width=\"245\" height=\"326\" \/><\/a><\/li>\n<li>Enter a <strong>Name<\/strong> for the task, which also doubles up as the <strong>Display Name<\/strong>. Bot Store uses the display name of the task. You can change the display name if needed.<\/li>\n<li>Select the <strong>Connection Type and Mode <\/strong>(see table below for details) and click <strong>Create &amp; Proceed<\/strong>.<\/li>\n<li>The <strong>Create Alert Task<\/strong> dialog opens. Enter the following details for the task:<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/general-dialog.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14170\" src=\"\/wp-content\/uploads\/sites\/12\/general-dialog.png\" alt=\"\" width=\"847\" height=\"359\" \/><\/a><\/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>Task Name<\/td>\n<td>The name of the alert task as displayed in the platform.<\/td>\n<\/tr>\n<tr>\n<td>Display Name<\/td>\n<td>The name of the alert task as displayed in the Bot Store. The Task Name doubles up as the display name by default. However, you can change the display name.<\/td>\n<\/tr>\n<tr>\n<td>Connection Type<a id=\"GenInfo\"><\/a><\/td>\n<td>Select one of these connection types for the task:<\/p>\n<ul>\n<li><strong>Webhook<\/strong> &#8211; The web application pushes data to a\u00a0task\u00a0URL endpoint provided by\u00a0Kore.ai.<\/li>\n<li><strong>RSS<\/strong> &#8211; The web service returns RSS feeds when polled by Kore.ai, and may require end-user login credentials.<\/li>\n<li><strong>Webservice<\/strong> &#8211; The web service sends data to Kore.ai when polled by Kore.ai using the end-user account login credentials.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Connection Mode<\/td>\n<td>When the <strong>Connection Type<\/strong> is set to <strong>Webservice<\/strong>, specify the <strong>Connection Mode<\/strong> for the connection as:<\/p>\n<ul>\n<li><strong>REST<\/strong> &#8211; The alert task uses a REST API connection. or<\/li>\n<li><strong>SOAP<\/strong> &#8211; The alert\u00a0task uses a SOAP API connection.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n<h4>Advanced Settings<\/h4>\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\/12\/general-advanced-settings.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14172\" src=\"\/wp-content\/uploads\/sites\/12\/general-advanced-settings.png\" alt=\"\" width=\"1067\" height=\"527\" \/><\/a><br \/>\nThe following table describes the optional\u00a0fields in the <strong>Advanced Settings<\/strong> section on the <strong>General<\/strong>\u00a0tab.<\/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 Install Confirmation Message<\/td>\n<td>The message displayed to the end-user when the task is successfully set up.<\/td>\n<\/tr>\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. When <strong>No<\/strong> is selected, the user is asked to confirm the task before running it.<\/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 Bot Store.<\/td>\n<\/tr>\n<tr>\n<td>Task Demo Link<\/td>\n<td>Enter a <span style=\"color: #0000ff\">www.youtube.com<\/span> link, for example,\u00a0<a href=\"https:\/\/www.youtube.com\/watch?v=qB3P7kDKXZ4\">https:\/\/www.youtube.com\/watch?v=qB3P7kDKXZ4<\/a>, to display a task demo icon next to the task displayed in the Bot Store.<\/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 id=\"auth\"><span class=\"ez-toc-section\" id=\"Authorization\">Authorization<\/span><\/h3>\n<p>You may need to define how the end-user must be authorized to get the alert task notification message. For example, <em>Twitter<\/em> is an alert task using web services that require an authorized end-user. The authorization for the alert task would be the same end-user log in username and password for <em>Twitter<\/em> to allow Kore.ai to access the end-user account and poll for the alert\u00a0task data.<\/p>\n<p class=\"note\"><strong>Note:<\/strong> Authorization for alert tasks with the <strong>Connection Type<\/strong> set to <strong>Webhook<\/strong> is not required as part of the alert\u00a0task configuration.<\/p>\n<p>After you define the general settings for an alert task, the next step is to go to the<strong> Authorization<\/strong>\u00a0section on the <strong>API Request<\/strong> tab as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskAPIRequestTabAuthentication-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16876\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskAPIRequestTabAuthentication-1.png\" alt=\"\" width=\"820\" height=\"461\" \/><\/a><br \/>\nTo get started with defining the<b>\u00a0Authorization<\/b>\u00a0for a\u00a0task, on 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\/12\/Expand-Icon.png\" width=\"20\" height=\"24\" \/> icon in the<b>\u00a0Authentication<\/b>\u00a0section.<br \/>\nIf you have previously defined authorization for this task, you can select it in the <strong>Authorization Provider<\/strong>\u00a0drop-down list. If your task does not require authentication, you can select <strong>None<\/strong> in the <strong>Authorization provider<\/strong> drop-down list as shown in the following image.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionOptions.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9854\" src=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionOptions.png\" alt=\"Action Task - API Request Tab - Authentication Section Options\" width=\"852\" height=\"249\" \/><\/a><br \/>\nTo define\u00a0a new authorization provider, click\u00a0<strong>Create New<\/strong> to display the <strong>New Authorization Mechanism<\/strong> dialog.<br \/>\nIn the <strong>Authorization Type<\/strong>\u00a0drop-down list, select the type of authorization used by your Bot\u00a0as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYNewAuthMech-6.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-8659 size-full\" src=\"\/wp-content\/uploads\/sites\/12\/DIYNewAuthMech-6.png\" alt=\"New Authorization Mechanism Dialog\" width=\"595\" height=\"291\" \/><\/a><br \/>\nYou can choose one of the following types of authorization:<\/p>\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=\"id6ae874f180a43\"  tabindex=\"0\" title=\"Setting Up Authorization using Basic Auth\"    >Setting Up Authorization using Basic Auth<\/span><div id=\"target-id6ae874f180a43\" 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\/12\/DIYBasicAuthDialog-3-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16879\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYTaskSubdomain-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16881\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYBasicAuthDialogAddIDP-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16884\" src=\"\/wp-content\/uploads\/sites\/12\/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>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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16883\" src=\"\/wp-content\/uploads\/sites\/12\/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=\"\/v7-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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9864\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYBasicAuthDialogTestAuthorizationDialog-5-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16886\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestSuccess.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9857\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9858\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/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=\"id6ae874f180a7b\"  tabindex=\"0\" title=\"Setting Up Authorization using oAuth v2 password grant\"    >Setting Up Authorization using oAuth v2 password grant<\/span><div id=\"target-id6ae874f180a7b\" 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\/12\/DIYoAuthv2PasswordDialog.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-8671\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYTaskSubdomain-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16881\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYBasicAuthDialogAddIDP-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16884\" src=\"\/wp-content\/uploads\/sites\/12\/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>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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16883\" src=\"\/wp-content\/uploads\/sites\/12\/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=\"\/v7-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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9864\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuthOAuthV2PassTest.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9862\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9858\" src=\"\/wp-content\/uploads\/sites\/12\/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=\"id6ae874f180a9a\"  tabindex=\"0\" title=\"Setting Up Authorization using OAuth v1\"    >Setting Up Authorization using OAuth v1<\/span><div id=\"target-id6ae874f180a9a\" 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\/12\/DIYOAUTHV1-3.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-8675 size-full\" src=\"\/wp-content\/uploads\/sites\/12\/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=\"\/v7-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\/12\/DIYTaskSubdomain-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-17135\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuthOAuthV1AddFields.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9863\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9855\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9864\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYTestAuthorizationDialogoAuth.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-8681 size-full\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9858\" src=\"\/wp-content\/uploads\/sites\/12\/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=\"id6ae874f180ab6\"  tabindex=\"0\" title=\"Setting Up Authorization using OAuth v2\"    >Setting Up Authorization using OAuth v2<\/span><div id=\"target-id6ae874f180ab6\" 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\/12\/DIYAuthorizationOAUTHV2Dialog.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-8680\" src=\"\/wp-content\/uploads\/sites\/12\/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=\"\/v7-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\/12\/DIYTaskSubdomain-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-8661\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuthOAuthV1AddFields.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9863\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9855\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9864\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYTestAuthorizationDialogoAuth.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-8681 size-full\" src=\"\/wp-content\/uploads\/sites\/12\/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=\"id6ae874f180ad0\"  tabindex=\"0\" title=\"Setting Up Authorization using an API Key\"    >Setting Up Authorization using an API Key<\/span><div id=\"target-id6ae874f180ad0\" 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\/12\/DIYAPIKey-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-8682\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYTaskSubdomain-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16881\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYBasicAuthDialogAddIDP-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16884\" src=\"\/wp-content\/uploads\/sites\/12\/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>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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicAuthField-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16883\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestAuth-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9864\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYTestAuthorizationDialogAPIKey.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-8683\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9858\" src=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskAPIRequestTabAuthenticationSectionBasicTestTestFail.png\" alt=\"Authentication Test Fail\" width=\"578\" height=\"409\" \/><\/a><br \/>\n<\/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>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"api-request\"><span class=\"ez-toc-section\" id=\"API_Request\">API Request<\/span><\/h3>\n<p>Configure the API request that asks for data from your Bot website, system, or web application for the task. You can configure the API Request Settings an action task for WebHook, Rest, SOAP or RSS APIs. You can define API Parameters, optional API task Initializer, API Request pre- or post-processor, and the API Request. You also need to add a Response Sample expected from your API Request payload.<br \/>\nAfter you define the authorization mechanism and then click <strong>Save Auth<\/strong>, you are ready to configure the alert task request. The configuration settings for an alert task\u00a0request are based on the\u00a0<strong>Connection Type<\/strong>\u00a0that you define for the task. For more information, click the corresponding section.<\/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=\"id6ae874f181172\"  tabindex=\"0\" title=\"Configuring API Request (WebHook)\"    >Configuring API Request (WebHook)<\/span><div id=\"target-id6ae874f181172\" class=\"collapseomatic_content \"><br \/>\nFor a task with the <strong>Connection Type<\/strong>\u00a0specified as <strong>Webhook<\/strong>, you will need to define:<\/p>\n<ul>\n<li><strong>Content Type<\/strong>\u00a0&#8211; They type of data exchanged between Kore.ai and your web application.<br \/>\n<strong>Defining the Content Type<\/strong><br \/>\nThe\u00a0<strong>Content Type<\/strong>\u00a0describes the type of data exchanged between Kore.ai and your Bot website or application, and the key-value pairs expected in the task\u00a0payload response. To define the Content Type for the API Request, expand the <strong>Content Type<\/strong> tab and select one of these options:<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/Content-Type-2.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14202\" src=\"\/wp-content\/uploads\/sites\/12\/Content-Type-2.png\" alt=\"\" width=\"1079\" height=\"441\" \/><\/a><\/p>\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\u00a0attribute-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><strong>Response Sample<\/strong> &#8211;\u00a0Define key-value pairs that you expect to receive in the <span style=\"background-color: #f6d5d9\">Alert\u00a0<\/span>task payload. The keys that you provide\u00a0are available as drop-down choices for handling the\u00a0data to display to the end-user.<br \/>\n<strong>Adding Response Sample Data<\/strong><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\/12\/DIYFormattedIcon.png\" width=\"26\" height=\"26\" \/>\u00a0icon.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/Sample-response-indent.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14126\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYUnFormattedIcon.png\" width=\"26\" height=\"26\" \/><\/strong>\u00a0icon.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<\/li>\n<li><strong>Alert Tasks Path<\/strong>\u00a0&#8211; Optionally define a specific path for\u00a0data from the API.<br \/>\n<strong>Defining the Alert Tasks Path<\/strong><br \/>\nThe last section, <strong>Alert\u00a0Tasks Path<\/strong>, is an optional field that you can specify if the <strong>Response Sample<\/strong>\u00a0section contains a hierarchical tree structure of data and you only want a specific hierarchical level submitted for the task request object.<br \/>\nTo define the <strong>Alert\u00a0Tasks Path<\/strong>\u00a0for an alert task using a webhook, on the <strong>API Request<\/strong> tab, click the <strong>Expand<\/strong>\u00a0<img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-8284 size-full\" src=\"\/wp-content\/uploads\/sites\/12\/Expand-Icon.png\" width=\"20\" height=\"24\" \/> icon in the <strong>Alert\u00a0Tasks Path<\/strong>\u00a0section as shown in the following\u00a0illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskAPIRequestTabAlertsTaskPath.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9901\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskAPIRequestTabAlertsTaskPath.png\" alt=\"Alert Task API Request Tab - Alerts Task Path\" width=\"884\" height=\"253\" \/><\/a><br \/>\nFor example, in the following <strong>Response Sample<\/strong>, you may only want to expose the <span style=\"color: #0000ff\">user<\/span>\u00a0data in the alert\u00a0task response by defining <span style=\"color: #0000ff\">user<\/span>\u00a0in the\u00a0<strong>Alert\u00a0Tasks Path<\/strong>\u00a0field.<\/p>\n<pre>   {\r\n   \"user\":{\r\n      \"timeZone\":\"Asia\/Kolkata\",\r\n      \"active\":\"true\",\r\n      \"displayName\":\"John Doe\",\r\n      \"avatarUrls\":{\r\n         \"32x32\":\"https:\/\/koreteam.atlassian.net\/secure\/useravatar?size=medium&amp;ownerId=john.doe&amp;avatarId=11801\",\r\n         \"16x16\":\"https:\/\/koreteam.atlassian.net\/secure\/useravatar?size=xsmall&amp;ownerId=john.doe&amp;avatarId=11801\",\r\n         \"24x24\":\"https:\/\/koreteam.atlassian.net\/secure\/useravatar?size=small&amp;ownerId=john.doe&amp;avatarId=11801\",\r\n         \"48x48\":\"https:\/\/koreteam.atlassian.net\/secure\/useravatar?ownerId=john.doe&amp;avatarId=11801\"\r\n      },\r\n      \"emailAddress\":\"john.doe@kore.com\",\r\n      \"key\":\"john.doe\",\r\n      \"name\":\"john.doe\",\r\n      \"self\":\"https:\/\/koreteam.atlassian.net\/rest\/api\/2\/user?username=john.doe\"\r\n   },\r\n   \"webhookEvent\":\"jira:issue_updated\",\r\n   \"timestamp\":\"1438431826045\",\r\n   \"user_key\":\"john.doe\",\r\n   \"user_id\":\"john.doe\"\r\n}<\/pre>\n<p>After you enter the <strong>Alert\u00a0Tasks Path<\/strong>\u00a0field, click <strong>Save<\/strong>.<\/li>\n<\/ul>\n<p><\/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=\"rest\"  tabindex=\"0\" title=\"Configuring API WebService Request (REST)\"    >Configuring API WebService Request (REST)<\/span><div id=\"target-rest\" class=\"collapseomatic_content \"><br \/>\nThe following illustration is an example of the <strong>API Request<\/strong> tab on the <strong>Edit Alert \u2013 &lt; <em>Task Name<\/em> &gt;<\/strong>\u00a0page for an alert\u00a0task with the\u00a0<strong>Connection Type<\/strong>\u00a0specified as <strong>Webservice<\/strong>\u00a0and the <strong>Connection Mode<\/strong> set to <strong>REST<\/strong>\u00a0defined on the <strong>General<\/strong>\u00a0tab.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskRequestPage1-1.png\"><br \/>\n<\/a><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/API-Request-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14177\" src=\"\/wp-content\/uploads\/sites\/12\/API-Request-1.png\" alt=\"\" width=\"919\" height=\"558\" \/><\/a><br \/>\nFor a task with the\u00a0<strong>Connection Type<\/strong>\u00a0specified as <strong>Webservice<\/strong>\u00a0and the <strong>Connection Mode<\/strong> set to\u00a0<strong>REST<\/strong>\u00a0you need to define:<\/p>\n<ul>\n<li><strong>Content Type<\/strong>\u00a0&#8211; The type of data exchanged between Kore.ai and your web application.<br \/>\n<span class=\"collapseomatic \" id=\"content-rest\"  tabindex=\"0\" title=\"Defining the Content Type\"    >Defining the Content Type<\/span><div id=\"target-content-rest\" class=\"collapseomatic_content \"><br \/>\nThe\u00a0<strong>Content Type<\/strong>\u00a0describes the type of data exchanged between Kore.ai and your Bot website or application, and the key-value pairs expected in the task\u00a0payload response. To define the Content Type for the API Request (REST), expand the <strong>Content Type<\/strong> tab and select one of these options:<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/Content-Type.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14179\" src=\"\/wp-content\/uploads\/sites\/12\/Content-Type.png\" alt=\"\" width=\"1079\" height=\"441\" \/><\/a><\/p>\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\u00a0attribute-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<p><\/div><\/li>\n<li><strong>Authentication<\/strong> \u2013 If required for your alert task, you will need to define the authentication to access the API, for example, using basic authorization, OAuth, or API Key. <a href=\"\/v7-1\/docs\/bots\/advanced-topics\/authorization\/bot-authentication\/\">Refer here for more details<\/a>.<\/li>\n<li><strong>Parameters<\/strong> \u2013 Define one or more parameters used to process the API request, for example, input from user prompts, selection by an end-user from a list of choices, a URL, and so forth.<br \/>\n<span class=\"collapseomatic \" id=\"param-rest\"  tabindex=\"0\" title=\"Defining Parameters for an Alert Task\"    >Defining Parameters for an Alert Task<\/span><div id=\"target-param-rest\" class=\"collapseomatic_content \"><br \/>\nFollow these steps to define 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.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/PAyload-parameters-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16889\" src=\"\/wp-content\/uploads\/sites\/12\/PAyload-parameters-1.png\" alt=\"\" width=\"650\" height=\"713\" \/><\/a><\/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>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>Parameter Type<\/td>\n<td>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>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>Is Multi Select<\/td>\n<td>Allows the user to make more than one selection or entry. This field is displayed depending on the <strong>Field Type<\/strong> selected.<\/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.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/Advanced-parameters.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14074\" src=\"\/wp-content\/uploads\/sites\/12\/Advanced-parameters.png\" alt=\"\" width=\"519\" height=\"536\" \/><\/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>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>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, &#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>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<\/li>\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\/12\/MoveDownIcon.png\" alt=\"\" width=\"22\" height=\"24\" \/>\u00a0and\u00a0<img loading=\"lazy\" decoding=\"async\" class=\"inline\" src=\"\/wp-content\/uploads\/sites\/12\/MoveUpIcon.png\" alt=\"\" width=\"22\" height=\"24\" \/>\u00a0icons to move the parameters.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskAPIRequestTabParametersSectionSort.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9786\" src=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskAPIRequestTabParametersSectionSort.png\" alt=\"Action Task - API Request Tab - Parameters Section - Sort\" width=\"872\" height=\"368\" \/><\/a><\/li>\n<\/ol>\n<p><\/div><\/li>\n<li><strong>Initializer<\/strong> \u2013 Specify custom JavaScript to run, or set session variables prior to creating a task instance when web services require code to be executed, or session variables set, or modification of user context details before an API request is executed.<br \/>\n<span class=\"collapseomatic \" id=\"initial-rest\"  tabindex=\"0\" title=\"Defining an Initializer for an Alert Task\"    >Defining an Initializer for an Alert Task<\/span><div id=\"target-initial-rest\" 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=\"\/v7-1\/docs\/bots\/bot-builder-tool\/dialog-task\/using-session-and-context-variables-in-tasks\/\">Using Session and Context Variables in Tasks<\/a>.Some 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\/12\/DIYActionTaskAPIRequestTabInitializerSection.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9792\" src=\"\/wp-content\/uploads\/sites\/12\/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><\/li>\n<li><strong>Request<\/strong> \u2013 Define a request chain used to make an API call to a web service to initiate the task using URLs and paths to your Bot\u00a0to 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.<br \/>\n<span class=\"collapseomatic \" id=\"request-rest\"  tabindex=\"0\" title=\"Defining the Request Chain for an Alert Task\"    >Defining the Request Chain for an Alert Task<\/span><div id=\"target-request-rest\" 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<h6>API Request<\/h6>\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<h6>Configuring the API Request<\/h6>\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\/12\/Add-API.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14120\" src=\"\/wp-content\/uploads\/sites\/12\/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<div class=\"alert alert-info\"><strong>Note:<\/strong> In some\u00a0URLs, you may want to\u00a0use proprietary Kore.ai parameter values for the <span style=\"color: #0000ff\">end<\/span> and <span style=\"color: #0000ff\">start<\/span> parameters. For more information about Kore.ai parameter values, see the Bot-specific documentation in\u00a0<a href=\"\/v7-1\/docs\/bots\/about-kore-bots\/addingbots\/\">Adding Bots<\/a>.<\/div>\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=\"\/v7-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\/12\/DIYActionTaskAPIRequestTabRequestSectionAddAPIDialogAuthHeaders.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9796\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabRequestSectionAddAPIDialogParams.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9797\" src=\"\/wp-content\/uploads\/sites\/12\/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<h6>Processors<\/h6>\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<h6>Pre-processors<\/h6>\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<h6>Adding a Pre-Processor<\/h6>\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\/12\/Add-Request.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14105\" src=\"\/wp-content\/uploads\/sites\/12\/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<h6>Adding a Post-Processor<\/h6>\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<h6 class=\"p1\"><strong>JSON Syntax<\/strong><\/h6>\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<h6><strong>Example<\/strong><\/h6>\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=\"\/v7-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\/12\/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\/12\/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\/12\/MoveDownIcon.png\" alt=\"\" width=\"22\" height=\"24\" \/> icon\u00a0to reorder the API requests.<\/p>\n<p class=\"note\"><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.<\/p>\n<p><\/div><\/li>\n<li><strong>Response Sample<\/strong> \u2013 Define key\/value pairs that you expect to receive in the task payload. The keys that you provide\u00a0are available as drop-down choices for handling the\u00a0data to display to the end-user.<br \/>\n<span class=\"collapseomatic \" id=\"response-rest\"  tabindex=\"0\" title=\"Adding the Response Sample to an Alert Task\"    >Adding the Response Sample to an Alert Task<\/span><div id=\"target-response-rest\" 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\/12\/DIYFormattedIcon.png\" width=\"26\" height=\"26\" \/>\u00a0icon.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/Sample-response-indent.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14126\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYUnFormattedIcon.png\" width=\"26\" height=\"26\" \/><\/strong>\u00a0icon.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p><\/div><\/li>\n<li><strong>Preview Website Link Content in Post<\/strong> &#8211;\u00a0The website preview content displayed in the task notification message.<br \/>\n<span class=\"collapseomatic \" id=\"preview-rest\"  tabindex=\"0\" title=\"Customizing the Website Preview Content\"    >Customizing the Website Preview Content<\/span><div id=\"target-preview-rest\" class=\"collapseomatic_content \"><br \/>\nSome web services send links to preview media as part of the payload response. In this section, you can enable or disable preview links, and define the path to the links in the payload. By default, website preview links are disabled. The following illustration is an example of the <strong>Preview Website Link Content in Post<\/strong> section, when <strong>Yes<\/strong> is selected.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskRESTAPIRequestTabPreview.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9950\" src=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskRESTAPIRequestTabPreview.png\" alt=\"API Request Tab - Preview Section\" width=\"993\" height=\"711\" \/><\/a>When enabled, define the path to the preview links in the payload in the <strong>Path to the Link(toPreview)<\/strong> field, if the path is not in the root of the payload. For example, in the following code example from an RSS payload, the path to the preview is<\/p>\n<pre class=\"toolbar:1 lang:default decode:true\">...\r\n\"item\": [\r\n    {\r\n        \"title\": \"U.S. to Boost Refugee Intake by 30,000 by 2017\",\r\n        \"guid\": {\r\n            \"-isPermaLink\": \"false\",\r\n            \"#text\": \"SB12418904751422433479504581245034032986752\"\r\n        },\r\n        \"link\": \"http:\/\/www.wsj.com\/articles\/john-kerry-says-u-s-to-admit-30-000-more-refugees-in-next-2-years-1442768498?mod=fox_australian\",\r\n        ...<\/pre>\n<p class=\"p1\">When\u00a0<strong>Preview website link content in Post<\/strong>\u00a0is enabled, select\u00a0preview objects such as:<\/p>\n<ul>\n<li><strong>Preview Title<\/strong> &#8211; Displays the title of the website content.<\/li>\n<li><strong>Preview Description<\/strong> &#8211; Displays the description of the website content.<\/li>\n<li><strong>Preview Media(Video)<\/strong> &#8211; Enables display of video links from the website content.<\/li>\n<li><strong>Preview Media(Image)<\/strong> &#8211;\u00a0Enables display of image\u00a0links from the website content.<\/li>\n<\/ul>\n<p><\/div><\/li>\n<\/ul>\n<p>Click <strong>Save<\/strong>\u00a0to save the API request settings.<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=\"rss\"  tabindex=\"0\" title=\"Configuring API WebService Request (RSS)\"    >Configuring API WebService Request (RSS)<\/span><div id=\"target-rss\" class=\"collapseomatic_content \"><br \/>\nFor a task with the\u00a0<strong>Connection Type<\/strong>\u00a0specified as <strong>Webservice<\/strong>\u00a0and the <strong>Connection Mode<\/strong> set to\u00a0<strong>RSS<\/strong>\u00a0you need to define:<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/API-Request-RSS.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14192\" src=\"\/wp-content\/uploads\/sites\/12\/API-Request-RSS.png\" alt=\"\" width=\"904\" height=\"521\" \/><\/a><\/p>\n<ul>\n<li><strong>Content Type<\/strong>\u00a0&#8211; The type of data exchanged between Kore.ai and your web application.<br \/>\n<span class=\"collapseomatic \" id=\"content-rss\"  tabindex=\"0\" title=\"Defining the Content Type\"    >Defining the Content Type<\/span><div id=\"target-content-rss\" class=\"collapseomatic_content \"><br \/>\nThe\u00a0<strong>Content Type<\/strong> describes the type of data exchanged between Kore.ai and your Bot website or application, and the key-value pairs expected in the task payload response. To define the Content Type for the API Request (RSS), expand the <strong>Content Type<\/strong> tab and select one of these options:<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/Content-Type.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14179\" src=\"\/wp-content\/uploads\/sites\/12\/Content-Type.png\" alt=\"\" width=\"1079\" height=\"441\" \/><\/a><\/p>\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\u00a0attribute-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<p><\/div><\/li>\n<li><strong>Authentication<\/strong> \u2013 If required for your alert task, you will need to define the authentication to access the API, for example, using basic authorization, OAuth, or API Key. <a href=\"#auth\">Refer here for more details<\/a>.<\/li>\n<li><strong>Parameters<\/strong> \u2013 Define one or more parameters used to process the API request, for example, input from user prompts, selection by an end-user from a list of choices, a URL, and so forth.<br \/>\n<span class=\"collapseomatic \" id=\"param-rss\"  tabindex=\"0\" title=\"Defining Parameters for an Alert Task\"    >Defining Parameters for an Alert Task<\/span><div id=\"target-param-rss\" class=\"collapseomatic_content \"><br \/>\nFollow these steps to define 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.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/PAyload-parameters-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-16889\" src=\"\/wp-content\/uploads\/sites\/12\/PAyload-parameters-1.png\" alt=\"\" width=\"650\" height=\"713\" \/><\/a><\/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>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>Parameter Type<\/td>\n<td>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>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>Is Multi Select<\/td>\n<td>Allows the user to make more than one selection or entry. This field is displayed depending on the <strong>Field Type<\/strong> selected.<\/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.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/Advanced-parameters.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14074\" src=\"\/wp-content\/uploads\/sites\/12\/Advanced-parameters.png\" alt=\"\" width=\"519\" height=\"536\" \/><\/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>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>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, &#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>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<\/li>\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\/12\/MoveDownIcon.png\" alt=\"\" width=\"22\" height=\"24\" \/>\u00a0and\u00a0<img loading=\"lazy\" decoding=\"async\" class=\"inline\" src=\"\/wp-content\/uploads\/sites\/12\/MoveUpIcon.png\" alt=\"\" width=\"22\" height=\"24\" \/>\u00a0icons to move the parameters.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskAPIRequestTabParametersSectionSort.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9786\" src=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskAPIRequestTabParametersSectionSort.png\" alt=\"Action Task - API Request Tab - Parameters Section - Sort\" width=\"872\" height=\"368\" \/><\/a><\/li>\n<\/ol>\n<p><\/div><\/li>\n<li><strong>Initializer<\/strong> \u2013 Specify custom JavaScript to run, or set session variables prior to creating a task instance when web services require code to be executed, or session variables set, or modification of user context details before an API request is executed.<br \/>\n<span class=\"collapseomatic \" id=\"initial-rss\"  tabindex=\"0\" title=\"Defining an Initializer for an Alert Task\"    >Defining an Initializer for an Alert Task<\/span><div id=\"target-initial-rss\" 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=\"\/v7-1\/docs\/bots\/bot-builder-tool\/dialog-task\/using-session-and-context-variables-in-tasks\/\">Using Session and Context Variables in Tasks<\/a>.Some 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\/12\/DIYActionTaskAPIRequestTabInitializerSection.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9792\" src=\"\/wp-content\/uploads\/sites\/12\/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><\/li>\n<li><strong>Request<\/strong> \u2013 Define a request chain used to make an API call to a web service to initiate the task using URLs and paths to your Bot\u00a0to 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.<br \/>\n<span class=\"collapseomatic \" id=\"request-rss\"  tabindex=\"0\" title=\"Defining the Request Chain for an Alert Task\"    >Defining the Request Chain for an Alert Task<\/span><div id=\"target-request-rss\" 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<h6>API Request<\/h6>\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<h6>Configuring the API Request<\/h6>\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\/12\/Add-API.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14120\" src=\"\/wp-content\/uploads\/sites\/12\/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<div class=\"alert alert-info\"><strong>Note:<\/strong> In some\u00a0URLs, you may want to\u00a0use proprietary Kore.ai parameter values for the <span style=\"color: #0000ff\">end<\/span> and <span style=\"color: #0000ff\">start<\/span> parameters. For more information about Kore.ai parameter values, see the Bot-specific documentation in\u00a0<a href=\"\/v7-1\/docs\/bots\/about-kore-bots\/addingbots\/\">Adding Bots<\/a>.<\/div>\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=\"\/v7-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\/12\/DIYActionTaskAPIRequestTabRequestSectionAddAPIDialogAuthHeaders.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9796\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYActionTaskAPIRequestTabRequestSectionAddAPIDialogParams.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9797\" src=\"\/wp-content\/uploads\/sites\/12\/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<h6>Processors<\/h6>\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<h6>Pre-processors<\/h6>\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<h6>Adding a Pre-Processor<\/h6>\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\/12\/Add-Request.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14105\" src=\"\/wp-content\/uploads\/sites\/12\/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<h6>Adding a Post-Processor<\/h6>\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<h6 class=\"p1\"><strong>JSON Syntax<\/strong><\/h6>\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<h6><strong>Example<\/strong><\/h6>\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=\"\/v7-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\/12\/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\/12\/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\/12\/MoveDownIcon.png\" alt=\"\" width=\"22\" height=\"24\" \/> icon\u00a0to reorder the API requests.<\/p>\n<p class=\"note\"><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.<\/p>\n<p><\/div><\/li>\n<li><strong>Response Sample<\/strong> \u2013 Define key\/value pairs that you expect to receive in the task payload. The keys that you provide\u00a0are available as drop-down choices for handling the\u00a0data to display to the end-user.<br \/>\n<span class=\"collapseomatic \" id=\"response-rss\"  tabindex=\"0\" title=\"Adding the Response Sample to an Alert Task\"    >Adding the Response Sample to an Alert Task<\/span><div id=\"target-response-rss\" 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\/12\/DIYFormattedIcon.png\" width=\"26\" height=\"26\" \/>\u00a0icon.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/Sample-response-indent.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14126\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYUnFormattedIcon.png\" width=\"26\" height=\"26\" \/><\/strong>\u00a0icon.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p><\/div><\/li>\n<li><strong>Preview Website Link Content in Post<\/strong> &#8211;\u00a0The website preview content displayed in the task notification message.<br \/>\n<span class=\"collapseomatic \" id=\"preview-rss\"  tabindex=\"0\" title=\"Customizing the Website Preview Content\"    >Customizing the Website Preview Content<\/span><div id=\"target-preview-rss\" class=\"collapseomatic_content \"><br \/>\nSome web services send links to preview media as part of the payload response. In this section, you can enable or disable preview links, and define the path to the links in the payload. By default, website preview links are disabled. The following illustration is an example of the <strong>Preview Website Link Content in Post<\/strong> section, when <strong>Yes<\/strong> is selected.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskRESTAPIRequestTabPreview.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9950\" src=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskRESTAPIRequestTabPreview.png\" alt=\"API Request Tab - Preview Section\" width=\"993\" height=\"711\" \/><\/a>When enabled, define the path to the preview links in the payload in the <strong>Path to the Link(toPreview)<\/strong> field, if the path is not in the root of the payload. For example, in the following code example from an RSS payload, the path to the preview is<\/p>\n<pre class=\"toolbar:1 lang:default decode:true\">...\r\n\"item\": [\r\n    {\r\n        \"title\": \"U.S. to Boost Refugee Intake by 30,000 by 2017\",\r\n        \"guid\": {\r\n            \"-isPermaLink\": \"false\",\r\n            \"#text\": \"SB12418904751422433479504581245034032986752\"\r\n        },\r\n        \"link\": \"http:\/\/www.wsj.com\/articles\/john-kerry-says-u-s-to-admit-30-000-more-refugees-in-next-2-years-1442768498?mod=fox_australian\",\r\n        ...<\/pre>\n<p class=\"p1\">When\u00a0<strong>Preview website link content in Post<\/strong>\u00a0is enabled, select\u00a0preview objects such as:<\/p>\n<ul>\n<li><strong>Preview Title<\/strong> &#8211; Displays the title of the website content.<\/li>\n<li><strong>Preview Description<\/strong> &#8211; Displays the description of the website content.<\/li>\n<li><strong>Preview Media(Video)<\/strong> &#8211; Enables display of video links from the website content.<\/li>\n<li><strong>Preview Media(Image)<\/strong> &#8211;\u00a0Enables display of image\u00a0links from the website content.<\/li>\n<\/ul>\n<p><\/div><\/li>\n<\/ul>\n<p>Click <strong>Save<\/strong>\u00a0to save the API request settings.<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=\"soap\"  tabindex=\"0\" title=\"Configuring API WebService Request (SOAP)\"    >Configuring API WebService Request (SOAP)<\/span><div id=\"target-soap\" class=\"collapseomatic_content \"><br \/>\nFor a task with the\u00a0<strong>Connection Type<\/strong>\u00a0specified as <strong>Webservice<\/strong>\u00a0and the <strong>Connection Mode<\/strong> set to\u00a0<strong>SOAP<\/strong>\u00a0you need to define:<\/p>\n<ul>\n<li><strong>Authentication<\/strong> \u2013 If required for your alert task, you will need to define the authentication to access the API, for example, using basic authorization, OAuth, or API Key as mentioned in the <a href=\"#auth\">previous section<\/a>.<\/li>\n<li><strong>WSDL URL<\/strong> \u2013 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.<br \/>\n<span class=\"collapseomatic \" id=\"wsdl-soap\"  tabindex=\"0\" title=\"Defining the WSDL URL\"    >Defining the WSDL URL<\/span><div id=\"target-wsdl-soap\" class=\"collapseomatic_content \"><\/p>\n<ol>\n<li>On the\u00a0<strong>API Request<\/strong>\u00a0tab, expand the\u00a0<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\u00a0<strong>WSDL URL<\/strong>\u00a0field.<a class=\"fancybox image\" ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/WSDL-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14133\" src=\"\/wp-content\/uploads\/sites\/12\/WSDL-1.png\" alt=\"\" width=\"1057\" height=\"208\" \/><\/a><\/li>\n<li>Click\u00a0<strong>Get WSDL Description<\/strong>. A\u00a0list of\u00a0<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 Alert Task Fields\u00a0if necessary for user input.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/Available-operators.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14186\" src=\"\/wp-content\/uploads\/sites\/12\/Available-operators.png\" alt=\"\" width=\"1070\" height=\"476\" \/><\/a><\/li>\n<\/ol>\n<h5>Customizing SOAP Alert Task Fields<\/h5>\n<p>You can customize the default input fields provided by Kore.ai after you select one or more of the <strong>Available Operations<\/strong>\u00a0from your WSDL. To customize the default <strong>Alert Task\u00a0Fields<\/strong>, click <strong>Edit<\/strong> for the <strong>Alert Task\u00a0Field<\/strong> that you want to customize. The <strong>Set up Alert\u00a0Task\u00a0Field<\/strong>\u00a0dialog is displayed as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/WSDL-edit-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14187\" src=\"\/wp-content\/uploads\/sites\/12\/WSDL-edit-1.png\" alt=\"\" width=\"578\" height=\"575\" \/><\/a><br \/>\nTo define end-user fields for a task, specify the values for the parameters in the <strong>Set up Alert\u00a0Task Field<\/strong> dialog as described in the following table.<\/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>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\u00a0setting 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>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>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<p>Click <strong>Add &amp; Continue<\/strong>\u00a0to save the alert\u00a0task\u00a0field for the API request and create another alert\u00a0task field, or click\u00a0<strong>Add &amp; Exit<\/strong>\u00a0to save the alert\u00a0task field for the API\u00a0request and close the dialog.<\/div><\/li>\n<li><strong>Access Using a connector<\/strong> \u2013 Specify if your Bots Platform is installed on-premises and you want to user the Kore.ai Connector agent.<br \/>\n<span class=\"collapseomatic \" id=\"connect-soap\"  tabindex=\"0\" title=\"Access Using a Connector\"    >Access Using a Connector<\/span><div id=\"target-connect-soap\" 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\/12\/Access-using-a-connector.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14139\" src=\"\/wp-content\/uploads\/sites\/12\/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 style=\"background-color: #ffffff\" href=\"\/v7-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><\/li>\n<li><strong>Response Sample<\/strong> \u2013 Define key\/value pairs that you expect to receive in the task payload. The keys that you provide\u00a0are available as drop-down choices for handling the\u00a0data to display to the end-user.<br \/>\n<span class=\"collapseomatic \" id=\"response-soap\"  tabindex=\"0\" title=\"Adding the Response Sample to an Alert Task\"    >Adding the Response Sample to an Alert Task<\/span><div id=\"target-response-soap\" 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\/12\/DIYFormattedIcon.png\" width=\"26\" height=\"26\" \/>\u00a0icon.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/Sample-response-indent.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14126\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYUnFormattedIcon.png\" width=\"26\" height=\"26\" \/><\/strong>\u00a0icon.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p><\/div><\/li>\n<li><strong>Preview Website Link Content in Post<\/strong> &#8211;\u00a0The website preview content displayed in the task notification message.<br \/>\n<span class=\"collapseomatic \" id=\"preview-soap\"  tabindex=\"0\" title=\"Customizing the Website Preview Content\"    >Customizing the Website Preview Content<\/span><div id=\"target-preview-soap\" class=\"collapseomatic_content \"><br \/>\nSome web services send links to preview media as part of the payload response. In this section, you can enable or disable preview links, and define the path to the links in the payload. By default, website preview links are disabled. The following illustration is an example of the <strong>Preview Website Link Content in Post<\/strong> section, when <strong>Yes<\/strong> is selected.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskRESTAPIRequestTabPreview.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9950\" src=\"\/wp-content\/uploads\/sites\/12\/DIYActionTaskRESTAPIRequestTabPreview.png\" alt=\"API Request Tab - Preview Section\" width=\"993\" height=\"711\" \/><\/a>When enabled, define the path to the preview links in the payload in the <strong>Path to the Link(toPreview)<\/strong> field, if the path is not in the root of the payload. For example, in the following code example from an RSS payload, the path to the preview is<\/p>\n<pre class=\"toolbar:1 lang:default decode:true\">...\r\n\"item\": [\r\n    {\r\n        \"title\": \"U.S. to Boost Refugee Intake by 30,000 by 2017\",\r\n        \"guid\": {\r\n            \"-isPermaLink\": \"false\",\r\n            \"#text\": \"SB12418904751422433479504581245034032986752\"\r\n        },\r\n        \"link\": \"http:\/\/www.wsj.com\/articles\/john-kerry-says-u-s-to-admit-30-000-more-refugees-in-next-2-years-1442768498?mod=fox_australian\",\r\n        ...<\/pre>\n<p class=\"p1\">When\u00a0<strong>Preview website link content in Post<\/strong>\u00a0is enabled, select\u00a0preview objects such as:<\/p>\n<ul>\n<li><strong>Preview Title<\/strong> &#8211; Displays the title of the website content.<\/li>\n<li><strong>Preview Description<\/strong> &#8211; Displays the description of the website content.<\/li>\n<li><strong>Preview Media(Video)<\/strong> &#8211; Enables display of video links from the website content.<\/li>\n<li><strong>Preview Media(Image)<\/strong> &#8211;\u00a0Enables display of image\u00a0links from the website content.<\/li>\n<\/ul>\n<p><\/div><\/li>\n<\/ul>\n<p>Click <strong>Save<\/strong>\u00a0to save the API request settings.<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 id=\"response-bot\"><span class=\"ez-toc-section\" id=\"Bot_Response\">Bot Response<\/span><\/h3>\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\/12\/DIYAlertTaskBotResponseTabReportSection.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-19542\" src=\"\/wp-content\/uploads\/sites\/12\/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=\"\/v7-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=\"\/v7-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=\"\/v7-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=\"\/v7-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=\"\/v7-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=\"\/v7-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=\"\/v7-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\/12\/Standard-text.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14145\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/Request-Response.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14147\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYBotResponseKeys.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9813\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/Standard-keys.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14148\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYBotResponseVariableSessionKeys.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-10221\" src=\"\/wp-content\/uploads\/sites\/12\/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=\"\/v7-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\/12\/DIYBotResponseVariableResponseKeys.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-10222\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/DIYBotResponseVariableReportKeys.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-10223\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/preview.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14151\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/bot-response-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14149\" src=\"\/wp-content\/uploads\/sites\/12\/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>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3 id=\"alert-settings\"><span class=\"ez-toc-section\" id=\"Alert_Settings\">Alert Settings<\/span><\/h3>\n<p>Define the schedule or filter settings for the alert. schedule alerts to trigger according to the days, times, and frequencies they specify, whereas filtered alerts rigger when certain thresholds are met such as amounts, dates, text matches, and more.<br \/>\nAfter you define the <strong>General<\/strong> tab settings for your Bot task, configure the <strong>API request chain<\/strong>, define the <strong>Bot response message<\/strong>, then you are ready to <strong>define the settings for the task<\/strong>, such as filters, when the alert task runs, and other advanced options. This section describes how to define the parameters on the <strong>Settings<\/strong> tab for an alert task.<\/p>\n<p class=\"note\"><strong>Note:<\/strong>\u00a0This section does not apply to webhook alert tasks.<\/p>\n<h4>What Do I Need to Do?<\/h4>\n<p>For an alert task, other than a webhook alert task, you will need to define:<\/p>\n<ul>\n<li><strong>Filters<\/strong> &#8211; You can define filters for end-users to limits the results of an alert task to the results an end-user needs. For example, you can define a filter for the name, or account, or business. When the alert is set up by the end-user, and the filter applied, only alert messages that meet the filter specifications are displayed to the end-user. For more information, see <a href=\"#filter\">Defining Filters for a Task<\/a>.<\/li>\n<li><strong>Schedule<\/strong> &#8211; Alert tasks only reach out to a web service for data when the Bot makes a request. For each task, you need to define when, and how often the web service is queried for data for an alert message. You can define the scheduling options presented to the end-user when the task is set up, as well as the default schedule for the task. For more information, see <a href=\"#schedule\">Configuring the Schedule for a Task<\/a>.<\/li>\n<li><strong>Advanced Settings<\/strong> &#8211; In the Advanced Settings section, you can define alert task settings for enabling and limiting the initial set of alert messages displayed to the end-user when the task is set up, define alert message reminders, and if required, prevent duplicate messages sent to the user. For more information, see <a href=\"#advanced\">Define Advanced Settings<\/a>.<\/li>\n<\/ul>\n<p><span class=\"collapseomatic \" id=\"filter\"  tabindex=\"0\" title=\"Defining Filters for a Task\"    >Defining Filters for a Task<\/span><div id=\"target-filter\" class=\"collapseomatic_content \"><br \/>\nTo get started with defining filters for a\u00a0task, on the <strong>Settings<\/strong>\u00a0tab, click the <strong>Expand<\/strong> icon in the <strong>Filters<\/strong> section, and then click <strong>Add<\/strong> as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabFiltersSection.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9925\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabFiltersSection.png\" alt=\"Alert Task - Settings Tab - Filters Section\" width=\"783\" height=\"303\" \/><\/a><br \/>\nWhen you\u00a0click <strong>Add<\/strong>, the <strong>Alert\u00a0Task Filter<\/strong> dialog is displayed as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskResponseAlertTaskFilterDialog.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-8819\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskResponseAlertTaskFilterDialog.png\" alt=\"Alert Task Filter Dialog\" width=\"447\" height=\"862\" \/><\/a><br \/>\nThe <strong>Filter<\/strong> defined in the previous illustration is displayed to the end-user as a filter labeled <em>Owner<\/em>, with the <strong>Field Type<\/strong> set to\u00a0<strong>Dynamic Dropdown<\/strong>\u00a0to enable the end-user to select a name from a dynamically populated list of owners defined in the response payload.<br \/>\nDefine the fields described in the following table to create a new filter for a task.<\/p>\n<table>\n<tbody>\n<tr>\n<td><strong>PARAMETER NAME<\/strong><\/td>\n<td><strong>DESCRIPTION<\/strong><\/td>\n<\/tr>\n<tr>\n<td>Name<\/td>\n<td>Specify the name of the <strong>Filter<\/strong>\u00a0displayed to the end-user in <strong>Filters<\/strong> section when configuring the task, for example, Notify me only when the below user tweets.<\/td>\n<\/tr>\n<tr>\n<td>Field Name<\/td>\n<td>Enter the name of the field to filter the task on, or click <strong>Select Field<\/strong> to display a drop-down list of field names parsed from the <strong>Response Sample<\/strong> defined on the task\u00a0<b>API Request<\/b> tab.<\/td>\n<\/tr>\n<tr>\n<td>Field Type<\/td>\n<td>Select the type of input field to collect the user input.<\/p>\n<ul>\n<li><strong>Textbox<\/strong> &#8211; Displays a text box to the user. In the <strong>Placeholder<\/strong> field, enter a description for the field, for example, <span style=\"color: #0000ff\">Type\u00a0in the name you want to embroider.<\/span><\/li>\n<li><strong>Textarea<\/strong> &#8211; Displays a text area box to the user, typically allowing to enter several sentences. In the <strong>Placeholder<\/strong> field, enter a description for the text area.<\/li>\n<li><strong>Static Dropdown<\/strong> &#8211; Displays a drop-down list of choices to the user. Click <strong>Add Option<\/strong> to begin adding the list of items, with the following parameters:\n<ul>\n<li><strong>Option Name <\/strong>&#8211; The name of the option displayed to the user.<\/li>\n<li><strong>Option Value<\/strong> &#8211; The value associated with the option.<\/li>\n<li><strong>Default Value<\/strong> &#8211; Select the default value for the list when more than one option is defined.<\/li>\n<li><strong>Searchable<\/strong> &#8211; Select to enable type-ahead suggestions from the list matching the user&#8217;s typing.<\/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 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; One of these content types expected from the specified endpoint URL: JSON, RSS, XML, Encoded JSON, CSV, or Text.<\/li>\n<li><strong>Endpoint Method<\/strong> &#8211; Select one of the following:\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>Optional 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<\/ul>\n<\/li>\n<\/ul>\n<ul>\n<li><strong>Check Box<\/strong> &#8211; Displays a list of choices that the user can select from &#8211; one or more.\u00a0Click <strong>Add Option<\/strong> to begin adding the list of items to display, 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 corresponding value for the option name.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Type Ahead<\/strong>\u00a0&#8211; Displays a dynamically populated drop-down list of choices to the 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; Select one of the following:\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><b>Dynamic Check Box<\/b> &#8211;\u00a0Displays a list of choices that the end-user can select one or more from, which are 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 list of choices as checkboxes.\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, Encoded JSON, CSV, or Text.<\/li>\n<li><strong>Endpoint Method<\/strong> &#8211; Select one of the following:\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>Box\u00a0Value Key<\/strong> &#8211; The key for the value of the drop-down option, for example, <span style=\"color: #0000ff\">id<\/span>.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Data Type<\/td>\n<td>The data type for the content received from the endpoint URL. One of:<\/p>\n<ul>\n<li><strong>Text<\/strong> &#8211; The user input\u00a0for this filter is expected as text.<\/li>\n<li><strong>Number<\/strong> &#8211; The user input for this filter\u00a0is expected as an integer.<\/li>\n<li><strong>Date<\/strong> &#8211; The user input for this filter\u00a0is a date.<\/li>\n<li><strong>List<\/strong> &#8211; The user input for this filter is a comma-separated list.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Operators<\/td>\n<td>Select one or more filter operations that the end-user can select to apply to the filter. Depending on the <strong>Data Type<\/strong> selected, one or more of the following options are available to select to display to the end-user in the filter.<\/p>\n<ul>\n<li><strong>Contains<\/strong> &#8211; The response\u00a0object filtered text contains all\u00a0of the specified values.<\/li>\n<li><strong>Doesn&#8217;t Contain<\/strong> &#8211; The response object filtered text does not contain all\u00a0of the specified values.<\/li>\n<li><strong>Exact Match<\/strong> &#8211; The response object filtered text only contains the specified values.<\/li>\n<li><strong>Not an exact match<\/strong> &#8211; The response filtered text object does not contain the\u00a0specified value.<\/li>\n<li><strong>Included<\/strong> &#8211; The response object filtered text contains\u00a0any of the specified values.<\/li>\n<li><strong>Not Included<\/strong> &#8211; The response object filtered text does not contain any of the specified values.<\/li>\n<li><strong>Starts with<\/strong> &#8211; The response object filtered text begins with the specified\u00a0value.<\/li>\n<li><strong>Doesn&#8217;t start with<\/strong> &#8211; The response object filtered text does not begin with the specified value.<\/li>\n<li><strong>Ends with<\/strong> &#8211; The response object filtered text ends with the specified value.<\/li>\n<li><strong>Doesn&#8217;t end with<\/strong> &#8211; The response object filtered text does not end with the specified value.<\/li>\n<li><strong>Equal to<\/strong> &#8211; The response object filtered numbers or dates\u00a0are\u00a0equal to the specified value.<\/li>\n<li><strong>Greater than<\/strong> &#8211; The response object filtered numbers or dates\u00a0are\u00a0greater than the specified value.<\/li>\n<li><strong>Less than<\/strong> &#8211; The response object filtered numbers or dates are less than the specified value.<\/li>\n<li><strong>Exists<\/strong> &#8211; The response object filtered list contains the specified value.<\/li>\n<li><strong>Doesn&#8217;t exist<\/strong> &#8211; The response object filter list does not contain the specified value.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>For multiple filters, you can order the filters\u00a0in an\u00a0order the end-user expects, shown in numerical order in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabFiltersSection.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9925\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabFiltersSection.png\" alt=\"Alert Task - Settings Tab - Filters Section\" width=\"783\" height=\"303\" \/><\/a><br \/>\nUse the <strong>Move\u00a0Up<\/strong>\u00a0<img loading=\"lazy\" decoding=\"async\" class=\"inline\" src=\"\/wp-content\/uploads\/sites\/12\/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\/12\/MoveDownIcon.png\" alt=\"\" width=\"22\" height=\"24\" \/> icon in the <strong>Actions<\/strong>\u00a0column in the <strong>Filters<\/strong>\u00a0section to reorder the filters\u00a0if needed.<br \/>\nClick the <strong>Edit<\/strong>\u00a0<img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-9790 size-full\" src=\"\/wp-content\/uploads\/sites\/12\/EditIcon-1.png\" width=\"16\" height=\"16\" \/>\u00a0icon to modify the settings for an existing filter.<br \/>\nClick the <strong>Delete <img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-9789 size-full\" src=\"\/wp-content\/uploads\/sites\/12\/DeleteIcon.png\" width=\"14\" height=\"16\" \/>\u00a0<\/strong>icon to delete an existing filter.<br \/>\n<strong>Warning:<\/strong> This operation\u00a0is permanent and cannot be undone.<br \/>\n<\/div><br \/>\n<span class=\"collapseomatic \" id=\"schedule\"  tabindex=\"0\" title=\"Configuring the Schedule for a Task\"    >Configuring the Schedule for a Task<\/span><div id=\"target-schedule\" class=\"collapseomatic_content \"><br \/>\nYou need to configure the default settings for how often the task runs to request data from your web service. This topic describes how to configure the recurrence\u00a0for a task.<br \/>\nTo get started with defining the schedule to run a\u00a0task, on the <strong>Settings<\/strong>\u00a0tab, click the <strong>Expand<\/strong> icon in the <strong>Schedule<\/strong>\u00a0section as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabScheduleSection.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9931\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabScheduleSection.png\" alt=\"Alert Task - Settings Tab - Schedule Section\" width=\"765\" height=\"345\" \/><\/a><br \/>\nTo configure the schedule for your task, you must\u00a0define the <strong>Trigger Interval Options<\/strong>, and then the <strong>Default\u00a0Trigger Interval.<\/strong> The\u00a0<strong>Default Trigger Interval<\/strong> is the elapsed time between the last task request and the next automated task request.<br \/>\nTo set the options displayed to the end-user, in the <strong>Trigger Interval Options<\/strong> section:<\/p>\n<ul>\n<li>In the first field, select one or more of <strong>Daily<\/strong>, <strong>Weekday<\/strong>, <strong>Weekend<\/strong>, or <strong>Select All<\/strong>, and then click <strong>OK<\/strong>.<\/li>\n<li>In the second field, select one or more of <strong>Daily<\/strong>, <strong>Weekday<\/strong>, <strong>Weekend<\/strong>, or <strong>Select All<\/strong>, and then click <strong>OK<\/strong>.<\/li>\n<li>In the third\u00a0field, select one or more of the available 30-minute intervals, or <strong>Select All<\/strong>, and then click <strong>OK<\/strong>.<\/li>\n<\/ul>\n<p>In the following illustration, the end-user and <strong>Default Trigger Interval<\/strong> settings can be set to <strong>Daily, Weekend<\/strong>, or<strong> Weekday At<\/strong> &lt; <em><strong>any 30-minute interval\u00a0<\/strong><\/em>&gt;.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabScheduleSectionTrigger.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9932\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabScheduleSectionTrigger.png\" alt=\"Alert Task - Settings Tab - Schedule Section - Trigger Interval\" width=\"685\" height=\"272\" \/><\/a><br \/>\n<\/div><br \/>\n<span class=\"collapseomatic \" id=\"advanced\"  tabindex=\"0\" title=\"Defined Advanced Settings\"    >Defined Advanced Settings<\/span><div id=\"target-advanced\" class=\"collapseomatic_content \"><br \/>\nIn the <strong>Advanced Settings<\/strong> section, you can define the initial polling results for a task, define an alert reminder, and specify keys the Bots Platform should use to prevent duplicate alert messages, for example, in a <em>Twitter<\/em> or <em>Facebook<\/em> feed.<br \/>\nTo define advanced settings for a\u00a0task, on the <strong>Settings<\/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\/12\/Expand-Icon.png\" width=\"20\" height=\"24\" \/> icon in the <strong>Advanced Settings<\/strong>\u00a0section as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabAdvancedSettngsSection.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9933\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabAdvancedSettngsSection.png\" alt=\"AlertTask - Settings Tab - Advanced Settings Section\" width=\"766\" height=\"564\" \/><\/a><\/p>\n<h5>Initial Polling Setup<\/h5>\n<p>Initial polling is an option you can define to enable display of events to end-users immediately after they set up the task. For example, for a <em>CNN News Bots<\/em>, you can enable initial polling to show the last 10 news posts immediately after the end-user adds the task to their application. If initial polling is not defined, the task polling begins after the specified <strong>Trigger Interval<\/strong> has elapsed.<br \/>\nTo enable and configure initial polling, in the <strong>Perform Initial Poll<\/strong>\u00a0section, select <strong>Yes<\/strong>. In the <strong>No of posts<\/strong> field, enter the number of previous posts that should be posted immediately in the end-user application, as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabAdvancedSettingsSectionPoll.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9934\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabAdvancedSettingsSectionPoll.png\" alt=\"Initial Polling for a Task\" width=\"663\" height=\"155\" \/><\/a><\/p>\n<h5><span class=\"wysiwyg-font-size-large\">Setting Up Alert Reminders<\/span><\/h5>\n<p>For some tasks, for example, <em>Google Calendar<\/em> <em>Event Updates<\/em> task, you may want to add a reminder to the task. The reminder sends a reminder message to the end-user after receipt of\u00a0the original task message. For example, the end-user may want to set up a 30-minute and 15-minute reminder before an event with the task message.<br \/>\nTo enable and configure reminders, in the <strong>Enable Alert Reminder<\/strong> section, click <strong>Yes<\/strong>. The reminder configuration section is displayed as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabAdvancedSettngsSectionReminder1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9935\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabAdvancedSettngsSectionReminder1.png\" alt=\"Task Reminder\" width=\"823\" height=\"779\" \/><\/a><br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabAdvancedSettngsSectionReminder2.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-9936 size-full\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabAdvancedSettngsSectionReminder2.png\" alt=\"Task Reminder Part 2\" width=\"830\" height=\"629\" \/><\/a><br \/>\n<strong>To configure an alert reminder<\/strong><\/p>\n<ol>\n<li>In the <strong>Enable Alert Reminder<\/strong> section, click <strong>Yes<\/strong> to display the alert reminder settings.<\/li>\n<li>In the <strong>Reminder Frequency<\/strong> section, click in the text box to display and select one or more intervals for the frequency of the reminder ranging from <strong>5 mins<\/strong> to <strong>7 days<\/strong>.<\/li>\n<li>In the <strong>Reminder Message<\/strong> text area, enter the message to display to the end-user for the event reminder. For example,<br \/>\n<code>print('Event starts in '+__frequency__);<\/code><br \/>\nTo use system generated keys, click <strong>Select any key<\/strong> and choose a key from the dropdown list.<\/li>\n<li>In the <strong>Identity Event Modification<\/strong> section, enter one or more keys in a comma-separated list used to identify new events. For example,\u00a0<span style=\"color: #0000ff\">id, LastModifiedDateTime, subject<\/span>.<\/li>\n<li>In the <strong>Event Start Time<\/strong> section, enter the message to display to the end-user for the start date and time of the event using the alert\u00a0task\u00a0payload field that contains the event start time. For example,\n<pre class=\"lang:default decode:true \">  if (due_at) {\r\n       print(due_at);\r\n   } else if (due_on) {\r\n       var dt = new Date(created_at);\r\n       var dtt = new Date(due_on);\r\n       dt.setYear(dtt.getFullYear());\r\n       dt.setMonth(dtt.getMonth());\r\n       dt.setDate(dtt.getDate());\r\n       dt.setHours(00);\r\n       dt.setMinutes(00);\r\n       dt.setSeconds(00)\r\n       print(dt.toISOString());\r\n   }<\/pre>\n<\/li>\n<li>In the <strong>Format to Identify Recurrence<\/strong> section, select the type of recurrence pattern format used\u00a0in the payload as one of <strong>RRule<\/strong> or <strong>Cron.<\/strong>\n<ul>\n<li><strong>RRule<\/strong> &#8211; A JavaScript library for working with recurrence rules for calendar dates. Use this for iCalendar events. For more information, see <a href=\"http:\/\/www.kanzaki.com\/docs\/ical\/rrule.html\">Recurrence Rule<\/a>.<\/li>\n<li><strong>Cron<\/strong> &#8211; Used for scheduling tasks in the future. For more information, see <a href=\"https:\/\/en.wikipedia.org\/wiki\/Cron#CRON_expression\">Cron Expressions<\/a>.<\/li>\n<\/ul>\n<\/li>\n<li>In the <strong>Recurrence Pattern<\/strong> section, define the string displayed to the end-user to show the frequency of a repeating event, such as\u00a0a recurring weekly meeting. For example,\n<pre class=\"toolbar:1 lang:default decode:true \">if (typeof(Recurrence) !== 'undefined' &amp;&amp; Recurrence) {\r\n    var map = new Object();\r\n    map['Daily'] = \"DAILY\";\r\n    map['Weekly'] = \"WEEKLY\";\r\n    map['AbsoluteMonthly'] = \"MONTHLY\";\r\n    map['RelativeMonthly'] = \"MONTHLY\";\r\n    map['AbsoluteYearly'] = \"YEARLY\";\r\n    map['AbsoluteYearly'] = \"YEARLY\";\r\n    map['First'] = 1\r\n    map['Second'] = 2\r\n    map['Third'] = 3\r\n    map['Fourth'] = 4\r\n    map['Last'] = -1\r\n    map['Sunday'] = 'SU'\r\n    map['Monday'] = 'MO'\r\n    map['Tuesday'] = 'TU'\r\n    map['Wednesday'] = 'WE'\r\n    map['Thursday'] = 'TH'\r\n    map['Friday'] = 'FR'\r\n    map['Saturday'] = 'SA'\r\n    var rrule = '';\r\n    if (typeof(Recurrence.Pattern.Type) !== 'undefined') {\r\n        var freq = map[Recurrence.Pattern.Type];\r\n        rrule = rrule + 'FREQ=' + freq + ';';\r\n    }\r\n    if (typeof(Recurrence.Range.StartDate) !== 'undefined') {\r\n        var stDate = new Date(Recurrence.Range.StartDate).toISOString();\r\n        rrule = rrule + 'DTSTART=' + stDate + ';';\r\n    }\r\n    if (typeof(Recurrence.Pattern.Interval) !== 'undefined') {\r\n        var interval = Recurrence.Pattern.Interval\r\n        rrule = rrule + 'INTERVAL=' + interval + ';';\r\n    }\r\n    if (typeof(Recurrence.Range.EndDate) !== 'undefined' &amp;&amp; Recurrence.Range.Type !== 'NoEnd') {\r\n        var edDate = new Date(Recurrence.Range.EndDate).toISOString();\r\n        rrule = rrule + 'UNTIL=' + edDate + ';';\r\n    }\r\n    if (typeof(Recurrence.Pattern.Month) !== 'undefined' &amp;&amp; Recurrence.Pattern.Month !== 0) {\r\n        rrule = rrule + 'BYMONTH=' + Recurrence.Pattern.Month + ';';\r\n    }\r\n    if (typeof(Recurrence.Pattern.DayOfMonth) !== 'undefined' &amp;&amp; Recurrence.Pattern.DayOfMonth !== 0) {\r\n        rrule = rrule + 'BYMONTHDAY=' + Recurrence.Pattern.DayOfMonth + ';';\r\n    }\r\n    if (typeof(Recurrence.Pattern.Index) !== 'undefined') {\r\n        var wno = map[Recurrence.Pattern.Index];\r\n        rrule = rrule + 'BYSETPOS=' + wno + ';';\r\n    }\r\n    if (typeof(Recurrence.Pattern.DaysOfWeek) !== 'undefined') {\r\n        var arr = [];\r\n        for (var i = 0; i &lt; Recurrence.Pattern.DaysOfWeek.length; i++) {\r\n            arr.push(map[Recurrence.Pattern.DaysOfWeek[i]])\r\n        }\r\n        rrule = rrule + 'BYDAY=' + arr.join(',') + ';';\r\n    }\r\n    print(rrule);\r\n}<\/pre>\n<\/li>\n<li>If the <strong>Format to Identify Recurrence<\/strong>\u00a0field is set to <strong>Cron<\/strong>, then define the <strong>Event End\u00a0<\/strong>section to define the string displayed to the end-user to show the date and time of the last recurring event.<\/li>\n<\/ol>\n<p>Click <strong>Save<\/strong> to save the settings.<\/p>\n<h6><span class=\"wysiwyg-font-size-large\">Preventing Duplicate\u00a0Message\u00a0Alerts<\/span><\/h6>\n<p>After you add your filters for the response object, you should determine if you need to apply a strategy to prevent the display of duplicate messages to the end-user. For example, if you set up an RSS task, you may want to prevent duplicate messages\u00a0for the same subject, or for <em>Facebook<\/em>, prevent duplicate\u00a0messages each time a comment is added to a post.<br \/>\nIn Kore.ai, you can choose one of two\u00a0options for\u00a0<strong>Deduplicate Strategy<\/strong>:<\/p>\n<ul>\n<li><strong>None<\/strong> &#8211; This is the default method to prevent duplicate alert\u00a0messages. Each<span class=\"s1\">\u00a0incoming task\u00a0payload is hashed and the latest 500 task\u00a0hash values are persisted. Each new task payload\u00a0is compared against the list to prevent duplicate task alert\u00a0messages. This option works for most tasks.<\/span><\/li>\n<li><strong>ExcludeByCachedIds<\/strong> &#8211; Select to enter one or more response identifier keys in a comma-separated list used to filter Kore.ai task alert\u00a0messages\u00a0and\u00a0prevent duplication based on the cached hash value of the key for up to 500 hash values. If any of the key hash values match the response object, then the alert\u00a0message\u00a0is filtered and not displayed.For RSS <strong>Alert\u00a0Types<\/strong>, RSS XML payloads are parsed as JSON. To filter by RSS item, enter <code>$..guid[0]._<\/code> to prevent duplicate messages\u00a0using\u00a0the XML &lt; <em>GUID<\/em>\u00a0&gt; tag parsed to JSON as:\n<pre class=\"toolbar:1 lang:default decode:true \">{\r\n    \"guid\": [\r\n        \"_\": \"some link\"\r\n    ]\r\n}<\/pre>\n<\/li>\n<\/ul>\n<p>To define settings to prevent duplication messages for a\u00a0task, on the <strong>Settings<\/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\/12\/Expand-Icon.png\" width=\"20\" height=\"24\" \/> icon in the <strong>Advanced Settings<\/strong>\u00a0section to display the <strong>Deduplicate Strategy<\/strong> section as shown in the following illustration.<br \/>\n<img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9937\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskSettingsTabAdvancedSettingsSectionDeDuplicate.png\" alt=\"Deduplicate Strategy Settings\" width=\"878\" height=\"166\" \/><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 id=\"ver-hist\"><span class=\"ez-toc-section\" id=\"Version_History\">Version History<\/span><\/h3>\n<p>You may need to troubleshoot alert\u00a0tasks that have been upgraded. In the Kore.ai Bot Builder tool, you can view version changes of each alert\u00a0task to determine if, and how many times an alert\u00a0task was upgraded.<br \/>\nIn the <strong>Alert\u00a0Tasks<\/strong>\u00a0section, click the <strong>Settings<\/strong> <img loading=\"lazy\" decoding=\"async\" class=\"inline\" src=\"\/wp-content\/uploads\/sites\/12\/DIYSettingsIcon-1.png\" alt=\"\" width=\"18\" height=\"18\" \/>\u00a0icon for the task\u00a0to view versions for, and then click\u00a0<strong>Version History<\/strong>.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/Version-History-3.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14455\" src=\"\/wp-content\/uploads\/sites\/12\/Version-History-3.png\" alt=\"\" width=\"1302\" height=\"240\" \/><\/a><br \/>\nThe <strong>Version History<\/strong> page contains the following columns:<\/p>\n<ul>\n<li><strong>Version Number<\/strong> &#8211; The version number of the upgrade as a minor upgrade, using X.X syntax, for example, <span style=\"color: #0000ff\">1.3<\/span> where <span style=\"color: #0000ff\">1<\/span> is the major version upgrade number, and <span style=\"color: #0000ff\">3<\/span> is the minor version upgrade number.<\/li>\n<li><strong>Changed By<\/strong> &#8211; The\u00a0username of the developer of the bot that made the upgrade changes.<\/li>\n<li><strong>Changed Date<\/strong> &#8211; The date that the bot was approved and published by the Enterprise Admin.<\/li>\n<li><strong>Comments<\/strong> &#8211; The <strong>Upgrade Comments<\/strong> provided by the developer that made the changes to the bot for an upgrade.<\/li>\n<\/ul>\n<p>The following illustration is an example of the <strong>Version History<\/strong> page for a bot with three minor upgrades, and one major upgrade to version 2.<\/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<h3 id=\"view-logs\"><span class=\"ez-toc-section\" id=\"View_Logs\">View Logs<\/span><\/h3>\n<p>You may need to troubleshoot alert tasks. In the Kore.ai Bot Builder tool, you can view logged events for configured and published alert tasks that interact with the Kore.ai Bots Platform and third-party applications. The <strong>View Logs<\/strong> command displays archived log events for each alert task instance that you can use to view the alert task request and the application response.<br \/>\nIn the <strong>Alert Tasks<\/strong>\u00a0section, click the <strong>Settings<\/strong> <img loading=\"lazy\" decoding=\"async\" class=\"inline\" src=\"\/wp-content\/uploads\/sites\/12\/DIYSettingsIcon-1.png\" alt=\"\" width=\"18\" height=\"18\" \/>\u00a0icon for the task\u00a0to view logs for, and then click\u00a0<strong>View Logs<\/strong>. The <strong>Logs<\/strong> page for the bot alert task opens.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskViewLogsPage-2.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-11551 size-full\" src=\"\/wp-content\/uploads\/sites\/12\/DIYAlertTaskViewLogsPage-2.png\" alt=\"View Logs Page\" width=\"1026\" height=\"837\" \/><\/a><br \/>\nYou can refresh the entries on the <strong>Logs<\/strong> page when needed.<br \/>\nEach log entry represents the results of the alert task as a JSON response.<\/p>\n<pre class=\"toolbar:1 lang:default decode:true\">{\r\n    \"requestLogs\": [{\r\n        \"name\": \"Request 1\",\r\n        \"request\": {\r\n            \"endpoint\": \"http:\/\/www.moneycontrol.com\/rss\/{channel}.xml\",\r\n            \"pathFields\": {\r\n                \"channel\": \"latestnews\",\r\n                \"lastRun\": \"2016-12-02T16:50:45Z\",\r\n                \"now\": \"2016-12-02T16:56:37Z\",\r\n                \"today\": \"2016-12-02\"\r\n            },\r\n            \"payloadFields\": {},\r\n            \"headerFields\": {\r\n                \"If-Modified-Since\": \"Fri, 02 Dec 2016 16:30:28 GMT\",\r\n                \"If-None-Match\": \"\\\"525734-3a49-5426bfa6dff80\\\"\"\r\n            }\r\n        },\r\n        \"response\": {\r\n            \"status\": 200,\r\n            \"headers\": {\r\n                \"server\": \"Kore.aiOps\",\r\n                \"last-modified\": \"Fri, 02 Dec 2016 16:50:10 GMT\",\r\n                \"accept-ranges\": \"bytes\",\r\n                \"content-encoding\": \"gzip\",\r\n                \"pragma\": \"no-cache\",\r\n                \"content-length\": \"3554\",\r\n                \"content-type\": \"application\/xml\",\r\n                \"vary\": \"Accept-Encoding\",\r\n                \"expires\": \"Wed, 11 Jan 1984 05:00:00 GMT\",\r\n                \"cache-control\": \"max-age=0, no-cache, no-store, must-revalidate\",\r\n                \"age\": \"0\",\r\n                \"connection\": \"keep-alive\"\r\n            },\r\n            \"body\": \"<!--?xml version=\"1.0\" encoding=\"ISO-8859-1\" ?--> \\n\\t<!-- generator=Moneycontrol XML FEED Generator --> \\n\\t \\n\\t\\t\\t\\n\\t\\t\\t\\tMoneycontrol Latest News\\n\\t\\t\\t\\tLatest News from Moneycontrol.com\\n\\t\\t\\t\\thttp:\/\/www.moneycontrol.com\\n\\t\\t\\t\\tFri, 02 Dec 2016 22:20:01 +0530\\n\\t\\t\\t\\tMoneycontrol.com\\n\\t\\t\\t\\t\\n\\t\\t\\t\\t\\thttp:\/\/img1.moneycontrol.com\/images\/top2010\/moneycontrol_logo.jpg\\n\\t\\t\\t\\t\\tMoneycontrol Logo\\n\\t\\t\\t\\t\\thttp:\/\/www.moneycontrol.com\\n\\t\\t\\t\\tFeed provided by Moneycontrol.\\n\\t\\t\\t\\t\\n\\t\\tPradhan proposes Rs 900 crore 2G Ethanol Plant in Odisha\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/wire-news\/pradhan-proposes-rs-900-crore-2g-ethanol-plantodisha_8058641.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/default\/200x200_default_img_grey.jpg\" alt=\"Pradhan proposes Rs 900 crore 2G Ethanol Plant in Odisha\" title=\"Pradhan proposes Rs 900 crore 2G Ethanol Plant in Odisha\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; Union Minister Dharmendra Pradhan\\ntoday proposed a 2G Ethanol Plant in Bargarh district at an\\ninvestment of Rs 900 crore and suggested the Odisha government\\nto develop Paradip on the lines of Jurong island of Singapore.\\n\\t\\tFri, 02 Dec 2016 22:16:04 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/wire-news\/pradhan-proposes-rs-900-crore-2g-ethanol-plantodisha_8058641.html\\n\\t\\t\\n\\t\\t\\n\\t\\tNote ban impact: How Vidisha farmers are coping\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/cnbc-tv18-comments\/note-ban-impact-how-vidisha-farmerscoping_8058621.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2014\/a\/ARCHANA4_200_0102.jpg\" alt=\"Archana Shukla\" title=\"Archana Shukla\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; The government's decision to ban old Rs 500 and Rs 1000 notes has made life difficult for small famers. Trading is a hassle and life in the Madhya Pradesh town is almost at a standstill.\\n\\t\\tFri, 02 Dec 2016 22:14:01 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/cnbc-tv18-comments\/note-ban-impact-how-vidisha-farmerscoping_8058621.html\\n\\t\\t\\n\\t\\t\\n\\t\\tCash crunch not a worry for grocery e-tailer BigBasket\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/cash-crunch-notworry-for-grocery-e-tailer-bigbasket_8058601.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2016\/b\/bigbasket.jpg\" alt=\"Cash crunch not a worry for grocery e-tailer BigBasket\" title=\"Cash crunch not a worry for grocery e-tailer BigBasket\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; While the demonetisation scheme is acting as a hurdle for many sectors, for BigBasket it is a blessing in disguise. The company has upped its revenue projection by 20 percent in the financial year 2017. \\n\\t\\tFri, 02 Dec 2016 22:13:12 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/cash-crunch-notworry-for-grocery-e-tailer-bigbasket_8058601.html\\n\\t\\t\\n\\t\\t\\n\\t\\tMallya PMLA case: Court confirms Rs 1,411 attachment order\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/mallya-pmla-case-court-confirms-rs-1411-attachment-order_8058581.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2016\/v\/Vijay_Mallya_Kingfisher_Mallya_london_200x200.jpg\" alt=\"Mallya PMLA case: Court confirms Rs 1,411 attachment order\" title=\"Mallya PMLA case: Court confirms Rs 1,411 attachment order\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; A special anti-money laundering\\r\\ncourt here has confirmed an attachment of assets order worth\\r\\nRs 1,411 crore issued by the ED against UBHL and others in\\r\\nconnection with its money laundering probe against liquor\\r\\nbaron Vijay Mallya and others.\\n\\t\\tFri, 02 Dec 2016 22:00:03 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/mallya-pmla-case-court-confirms-rs-1411-attachment-order_8058581.html\\n\\t\\t\\n\\t\\t\\n\\t\\tRussian central bank said it was victim of attempted cyber heist\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/world-news\/russian-central-bank-said-it-was-victimattempted-cyber-heist_8058321.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2016\/2\/2016-12-02T151033Z_1_LYNXMPECB114Y_RTROPTP_2_RUSSIA-CENBANK-LIQUIDITY-RATES_200.JPG\" alt=\"Russian central bank said it was victim of attempted cyber heist\" title=\"Russian central bank said it was victim of attempted cyber heist\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; The bank said it managed to recover some of that amount - USD26 million -- but it did not say if that meant the rest had been stolen.\\n\\t\\tFri, 02 Dec 2016 21:46:45 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/world-news\/russian-central-bank-said-it-was-victimattempted-cyber-heist_8058321.html\\n\\t\\t\\n\\t\\t\\n\\t\\tBank of England's Haldane warns against hasty rate hike\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/world-news\/bankenglands-haldane-warns-against-hasty-rate-hike_8058361.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2016\/2\/2016-12-02T125207Z_1_LYNXMPECB10TS_RTROPTP_2_BRITAIN-BOE_200.JPG\" alt=\"Bank of England's Haldane warns against hasty rate hike\" title=\"Bank of England's Haldane warns against hasty rate hike\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; The Bank of England's chief economist, Andrew Haldane, said on Friday it would be risky to raise interest rates too hastily and that he was comfortable with the BoE's recent shift to a neutral stance on what its next monetary policy move should be.\\n\\t\\tFri, 02 Dec 2016 21:44:54 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/world-news\/bankenglands-haldane-warns-against-hasty-rate-hike_8058361.html\\n\\t\\t\\n\\t\\t\\n\\t\\tTourists begin to feel the pinch of cash crunch\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/current-affairs\/tourists-begin-to-feelpinchcash-crunch_8057981.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/ai\/foreign_tourists_190.jpg\" alt=\"Tourists begin to feel the pinch of cash crunch\" title=\"Tourists begin to feel the pinch of cash crunch\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; The demonetisation move is impacting various segments of the society. The tourists coming to India are also feeling the pinch of the cash crunch. \\n\\t\\tFri, 02 Dec 2016 21:33:53 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/current-affairs\/tourists-begin-to-feelpinchcash-crunch_8057981.html\\n\\t\\t\\n\\t\\t\\n\\t\\tPolitical funding audits key to success of demonetisation: Pros\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/economy\/political-funding-audits-key-to-successdemonetisation-pros_8058301.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2016\/a\/Ashok_Lahiri_200.jpg\" alt=\"Ashok Lahiri\" title=\"Ashok Lahiri\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; The political parties must be open to audits, believe both Govinda Rao, former member, PMEA and Ashok Lahiri, former chief economic advisor. \\n\\t\\tFri, 02 Dec 2016 21:33:32 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/economy\/political-funding-audits-key-to-successdemonetisation-pros_8058301.html\\n\\t\\t\\n\\t\\t\\n\\t\\tCore Diagnostics gets $12mn funding from investors\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/core-diagnostics-gets-3612mn-fundinginvestors_8058561.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2016\/d\/Dollar_rupee_ip_down_200x200.jpg\" alt=\"Core Diagnostics gets $12mn funding from investors\" title=\"Core Diagnostics gets $12mn funding from investors\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; Core Diagnostics has received USD 12 million (around Rs 82 crore) funding from various investors including US-based F-Prime Capital Partners.\\n\\t\\tFri, 02 Dec 2016 21:24:15 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/core-diagnostics-gets-3612mn-fundinginvestors_8058561.html\\n\\t\\t\\n\\t\\t\\n\\t\\tItzCash ties up with 100 cos for pre-paid cards\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/itzcash-ties-up100-cos-for-pre-paid-cards_8058541.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2015\/c\/creditcardrewardpoints200X200.jpg\" alt=\"ItzCash ties up with 100 cos for pre-paid cards\" title=\"ItzCash ties up with 100 cos for pre-paid cards\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&amp;\r\namp;\r\ngt; Digital payments facilitator ItzCash has signed up with 100 small- and large-sized companies to offer pre-loaded salary cards for their employees in the wake of cash withdrawal limits from banks post ban on Rs 500\/1000 notes.\\n\\t\\tFri, 02 Dec 2016 21:24:13 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/itzcash-ties-up100-cos-for-pre-paid-cards_8058541.html\\n\\t\\t\\n\\t\\t\\n\\t\\tAmul to launch camel milk in next 3 months\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/amul-to-launch-camel-milknext-3-months_8058521.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2014\/p\/pro_amul_taaza_full_cream_milk_200_5901.jpg\" alt=\"Amul to launch camel milk in next 3 months\" title=\"Amul to launch camel milk in next 3 months\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; With food safety regulator FSSAI setting new standards for camel milk, dairy major GCMMF, which sells products under the Amul brand, today said it will launch camel milk in the next three months.\\n\\t\\tFri, 02 Dec 2016 21:24:12 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/amul-to-launch-camel-milknext-3-months_8058521.html\\n\\t\\t\\n\\t\\t\\n\\t\\tPar Panel asks coal PSUs to recover dues worth Rs 13,745 cr\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/current-affairs\/par-panel-asks-coal-psus-to-recover-dues-worth-rs-13745-cr_8058501.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2012\/c\/coalindia.jpg\" alt=\"Par Panel asks coal PSUs to recover dues worth Rs 13,745 cr\" title=\"Par Panel asks coal PSUs to recover dues worth Rs 13,745 cr\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; A Parliamentary panel has raised concerns over Rs 13,745 crore in dues to coal PSUs - CIL, SCCL and NLC - and asked them to recover the amount, which can adversely impact their financial position.\\n\\t\\tFri, 02 Dec 2016 21:24:11 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/current-affairs\/par-panel-asks-coal-psus-to-recover-dues-worth-rs-13745-cr_8058501.html\\n\\t\\t\\n\\t\\t\\n\\t\\tRuPay card usage jumps 118% in 1st week of demonetisation\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/rupay-card-usage-jumps-1181st-weekdemonetisation_8058481.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2015\/r\/rupay_200x200.jpg\" alt=\"RuPay card usage jumps 118% in 1st week of demonetisation\" title=\"RuPay card usage jumps 118% in 1st week of demonetisation\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; RuPay card usage jumped by over 118.6 per cent in the week following demonetisation that took effect from November 8 mid-night while the overall debit and credit card transactions recorded an increase of 70.5 per cent.\\n\\t\\tFri, 02 Dec 2016 21:24:10 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/rupay-card-usage-jumps-1181st-weekdemonetisation_8058481.html\\n\\t\\t\\n\\t\\t\\n\\t\\tBoB raises Rs 1,000 cr; SB of Travancore eyes Rs 600 cr\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/bob-raises-rs-1000-cr-sbtravancore-eyes-rs-600-cr_8058461.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2016\/b\/Banks_Queue_Bank_of_Baroda_200x200.jpg\" alt=\"BoB raises Rs 1,000 cr; SB of Travancore eyes Rs 600 cr\" title=\"BoB raises Rs 1,000 cr; SB of Travancore eyes Rs 600 cr\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; Public sector player Bank of Baroda has raised Rs 1,000 crore by issuing bonds that are compliant with global capital adequacy norms or Basel III.\\n\\t\\tFri, 02 Dec 2016 21:24:09 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/bob-raises-rs-1000-cr-sbtravancore-eyes-rs-600-cr_8058461.html\\n\\t\\t\\n\\t\\t\\n\\t\\tDCB Bank launches Cippy Wallet app for 'cash free' payments\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/dcb-bank-launches-cippy-wallet-app-for-cash-free-payments_8058441.html\\n\\t\\t&lt;img src=\"http:\/\/www.moneycontrol.com\/news_image_files\/2014\/d\/dcb_200.jpg\" alt=\"DCB Bank launches Cippy Wallet app for 'cash free' payments\" title=\"DCB Bank launches Cippy Wallet app for 'cash free' payments\" border=\"0\" width=\"75\" height=\"75\" align=\" left\" hspace=\"5\"\/&gt; Hopping on to the cashless drive, new generation private lender DCB Bank today launched Cippy Wallet app for digital payments.\\n\\t\\tFri, 02 Dec 2016 21:24:08 +0530\\n\\t\\thttp:\/\/www.moneycontrol.com\/news\/business\/dcb-bank-launches-cippy-wallet-app-for-cash-free-payments_8058441.html\\n\\t\\t\\n\\t\\t\"\r\n        },\r\n        \"executionTime\": \"4917 ms\"\r\n    }],\r\n    \"alertsData\": [{\r\n        \"uxmap\": {\r\n            \"channel\": \"default\",\r\n            \"body\": \"&lt;%    var newLink = '' + title + '';\\n  print(newLink);  %&gt;&lt;%print(\\\"\r\n\\\");%&gt;&lt;% %&gt;\"\r\n        },\r\n        \"payload\": \"{\\\"title\\\":[\\\"Pradhan proposes Rs 900 crore 2G Ethanol Plant in Odisha\\\"],\\\"link\\\":[\\\"http:\/\/www.moneycontrol.com\/news\/wire-news\/pradhan-proposes-rs-900-crore-2g-ethanol-plantodisha_8058641.html\\\"],\\\"description\\\":[\\\"<img decoding=\"async\" title=\"\\\\\\&quot;Pradhan\" src=\"\/\/www.moneycontrol.com\/news_image_files\/default\/200x200_default_img_grey.jpg\\\\\\&quot;\" alt=\"\\\\\\&quot;Pradhan\" width=\"\\\\\\&quot;75\\\\\\&quot;\" height=\"\\\\\\&quot;75\\\\\\&quot;\" align=\"\\\\\\&quot;\" border=\"\\\\\\&quot;0\\\\\\&quot;\" hspace=\"\\\\\\&quot;5\\\\\\&quot;\/\" \/> Union Minister Dharmendra Pradhan\\\\ntoday proposed a 2G Ethanol Plant in Bargarh district at an\\\\ninvestment of Rs 900 crore and suggested the Odisha government\\\\nto develop Paradip on the lines of Jurong island of Singapore.\\\"],\\\"pubDate\\\":[\\\"Fri, 02 Dec 2016 22:16:04 +0530\\\"],\\\"guid\\\":[\\\"http:\/\/www.moneycontrol.com\/news\/wire-news\/pradhan-proposes-rs-900-crore-2g-ethanol-plantodisha_8058641.html\\\"],\\\"hash\\\":\\\"f7dbaed7ebe3d9cb5f265779bd969da6\\\",\\\"_fields_\\\":{\\\"channel\\\":\\\"latestnews\\\"},\\\"_labels_\\\":{\\\"channel\\\":\\\"Latest News\\\"},\\\"secretKey\\\":\\\"n-5bd95008-81be-56d1-9030-0eafbf36a10d\\\",\\\"contentType\\\":\\\"application\/xml\\\",\\\"_last_run\\\":\\\"2016-12-02T16:50:45.363Z\\\"}\",\r\n        \"response\": {\r\n            \"channel\": \"default\",\r\n            \"body\": \"Pradhan proposes Rs 900 crore 2G Ethanol Plant in Odisha\r\n\",\r\n            \"updatedSessionStore\": {\r\n                \"EnterpriseContext\": {},\r\n                \"BotContext\": {},\r\n                \"UserContext\": {},\r\n                \"UserSession\": {},\r\n                \"BotUserSession\": {}\r\n            }\r\n        }\r\n    }, {\r\n        \"uxmap\": {\r\n            \"channel\": \"default\",\r\n            \"body\": \"&lt;%    var newLink = '' + title + '';\\n  print(newLink);  %&gt;&lt;%print(\\\"\r\n\\\");%&gt;&lt;% %&gt;\"\r\n        },\r\n        \"payload\": \"{\\\"title\\\":[\\\"Note ban impact: How Vidisha farmers are coping\\\"],\\\"link\\\":[\\\"http:\/\/www.moneycontrol.com\/news\/cnbc-tv18-comments\/note-ban-impact-how-vidisha-farmerscoping_8058621.html\\\"],\\\"description\\\":[\\\" The government's decision to ban old Rs 500 and Rs 1000 notes has made life difficult for small famers. Trading is a hassle and life in the Madhya Pradesh town is almost at a standstill.\\\"],\\\"pubDate\\\":[\\\"Fri, 02 Dec 2016 22:14:01 +0530\\\"],\\\"guid\\\":[\\\"http:\/\/www.moneycontrol.com\/news\/cnbc-tv18-comments\/note-ban-impact-how-vidisha-farmerscoping_8058621.html\\\"],\\\"hash\\\":\\\"ef03827acaf965207c72d21905ecc804\\\",\\\"_fields_\\\":{\\\"channel\\\":\\\"latestnews\\\"},\\\"_labels_\\\":{\\\"channel\\\":\\\"Latest News\\\"},\\\"secretKey\\\":\\\"n-5bd95008-81be-56d1-9030-0eafbf36a10d\\\",\\\"contentType\\\":\\\"application\/xml\\\",\\\"_last_run\\\":\\\"2016-12-02T16:50:45.363Z\\\"}\",\r\n        \"response\": {\r\n            \"channel\": \"default\",\r\n            \"body\": \"Note ban impact: How Vidisha farmers are coping\r\n\",\r\n            \"updatedSessionStore\": {\r\n                \"EnterpriseContext\": {},\r\n                \"BotContext\": {},\r\n                \"UserContext\": {},\r\n                \"UserSession\": {},\r\n                \"BotUserSession\": {}\r\n            }\r\n        }\r\n    }, {\r\n        \"uxmap\": {\r\n            \"channel\": \"default\",\r\n            \"body\": \"&lt;%    var newLink = '<a href=\"\\&quot;'\" target=\"\\&quot;_blank\\&quot;\" rel=\"noopener noreferrer\">' + title + '<\/a>';\\n  print(newLink);  %&gt;&lt;%print(\\\"\r\n\\\");%&gt;&lt;% %&gt;\"\r\n        },\r\n        \"payload\": \"{\\\"title\\\":[\\\"Mallya PMLA case: Court confirms Rs 1,411 attachment order\\\"],\\\"link\\\":[\\\"http:\/\/www.moneycontrol.com\/news\/business\/mallya-pmla-case-court-confirms-rs-1411-attachment-order_8058581.html\\\"],\\\"description\\\":[\\\"<img decoding=\"async\" title=\"\\\\\\&quot;Mallya\" src=\"\/\/www.moneycontrol.com\/news_image_files\/2016\/v\/Vijay_Mallya_Kingfisher_Mallya_london_200x200.jpg\\\\\\&quot;\" alt=\"\\\\\\&quot;Mallya\" width=\"\\\\\\&quot;75\\\\\\&quot;\" height=\"\\\\\\&quot;75\\\\\\&quot;\" align=\"\\\\\\&quot;\" border=\"\\\\\\&quot;0\\\\\\&quot;\" hspace=\"\\\\\\&quot;5\\\\\\&quot;\/\" \/> A special anti-money laundering\\\\r\\\\ncourt here has confirmed an attachment of assets order worth\\\\r\\\\nRs 1,411 crore issued by the ED against UBHL and others in\\\\r\\\\nconnection with its money laundering probe against liquor\\\\r\\\\nbaron Vijay Mallya and others.\\\"],\\\"pubDate\\\":[\\\"Fri, 02 Dec 2016 22:00:03 +0530\\\"],\\\"guid\\\":[\\\"http:\/\/www.moneycontrol.com\/news\/business\/mallya-pmla-case-court-confirms-rs-1411-attachment-order_8058581.html\\\"],\\\"hash\\\":\\\"ca41e9749166e2c0b47191460289b6b3\\\",\\\"_fields_\\\":{\\\"channel\\\":\\\"latestnews\\\"},\\\"_labels_\\\":{\\\"channel\\\":\\\"Latest News\\\"},\\\"secretKey\\\":\\\"n-5bd95008-81be-56d1-9030-0eafbf36a10d\\\",\\\"contentType\\\":\\\"application\/xml\\\",\\\"_last_run\\\":\\\"2016-12-02T16:50:45.363Z\\\"}\",\r\n        \"response\": {\r\n            \"channel\": \"default\",\r\n            \"body\": \"Mallya PMLA case: Court confirms Rs 1,411 attachment order\r\n\",\r\n            \"updatedSessionStore\": {\r\n                \"EnterpriseContext\": {},\r\n                \"BotContext\": {},\r\n                \"UserContext\": {},\r\n                \"UserSession\": {},\r\n                \"BotUserSession\": {}\r\n            }\r\n        }\r\n    }, {\r\n        \"uxmap\": {\r\n            \"channel\": \"default\",\r\n            \"body\": \"&lt;%    var newLink = '' + title + '';\\n  print(newLink);  %&gt;&lt;%print(\\\"\r\n\\\");%&gt;&lt;% %&gt;\"\r\n        },\r\n        \"payload\": \"{\\\"title\\\":[\\\"Cash crunch not a worry for grocery e-tailer BigBasket\\\"],\\\"link\\\":[\\\"http:\/\/www.moneycontrol.com\/news\/business\/cash-crunch-notworry-for-grocery-e-tailer-bigbasket_8058601.html\\\"],\\\"description\\\":[\\\" While the demonetisation scheme is acting as a hurdle for many sectors, for BigBasket it is a blessing in disguise. The company has upped its revenue projection by 20 percent in the financial year 2017. \\\"],\\\"pubDate\\\":[\\\"Fri, 02 Dec 2016 22:13:12 +0530\\\"],\\\"guid\\\":[\\\"http:\/\/www.moneycontrol.com\/news\/business\/cash-crunch-notworry-for-grocery-e-tailer-bigbasket_8058601.html\\\"],\\\"hash\\\":\\\"6f5635c0d5e19f73f8690859a4bd4f1d\\\",\\\"_fields_\\\":{\\\"channel\\\":\\\"latestnews\\\"},\\\"_labels_\\\":{\\\"channel\\\":\\\"Latest News\\\"},\\\"secretKey\\\":\\\"n-5bd95008-81be-56d1-9030-0eafbf36a10d\\\",\\\"contentType\\\":\\\"application\/xml\\\",\\\"_last_run\\\":\\\"2016-12-02T16:50:45.363Z\\\"}\",\r\n        \"response\": {\r\n            \"channel\": \"default\",\r\n            \"body\": \"Cash crunch not a worry for grocery e-tailer BigBasket\r\n\",\r\n            \"updatedSessionStore\": {\r\n                \"EnterpriseContext\": {},\r\n                \"BotContext\": {},\r\n                \"UserContext\": {},\r\n                \"UserSession\": {},\r\n                \"BotUserSession\": {}\r\n            }\r\n        }\r\n    }]\r\n}<\/pre>\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":"Alert tasks deliver timely, relevant, and personalized information from enterprise systems to customers and employees by polling the relevant service in real-time or according to a user-defined schedule. These alerts can contain detailed information, such as name, ID, notes, amount, and more, in a variety of formats for each channel. Key Features Scheduled Alerts: Users...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[67],"tags":[],"class_list":["post-17682","post","type-post","status-publish","format-standard","hentry","category-alert"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v7-1\/wp-json\/wp\/v2\/posts\/17682","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v7-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v7-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-1\/wp-json\/wp\/v2\/comments?post=17682"}],"version-history":[{"count":6,"href":"https:\/\/developer.kore.ai\/v7-1\/wp-json\/wp\/v2\/posts\/17682\/revisions"}],"predecessor-version":[{"id":22399,"href":"https:\/\/developer.kore.ai\/v7-1\/wp-json\/wp\/v2\/posts\/17682\/revisions\/22399"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v7-1\/wp-json\/wp\/v2\/media?parent=17682"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-1\/wp-json\/wp\/v2\/categories?post=17682"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-1\/wp-json\/wp\/v2\/tags?post=17682"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}