{"id":27054,"date":"2021-03-17T06:29:13","date_gmt":"2021-03-17T06:29:13","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=27054"},"modified":"2022-09-27T15:14:45","modified_gmt":"2022-09-27T14:14:45","slug":"alert-task-soap-api-request","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-builder-tool\/alert\/alert-task-soap-api-request\/","title":{"rendered":"Alert Task \u2013 SOAP API Request"},"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><span style=\"font-weight: 400\">In this article, we will see how to configure an API Request for a SOAP service, as part of an Alert Task. Learn more about Alert tasks <\/span><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-builder-tool\/alert\/notification-tasks\/\"><span style=\"font-weight: 400\">here<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/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>\n<h2><span class=\"ez-toc-section\" id=\"SOAP_API_Request_Overview\"><span style=\"font-weight: 400\">SOAP API Request Overview<\/span><\/span><\/h2>\n\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p>For a task with the&nbsp;<strong>Connection Type<\/strong>&nbsp;specified as <strong>Webservice<\/strong>&nbsp;and the <strong>Connection Mode<\/strong> set to&nbsp;<strong>SOAP<\/strong>&nbsp;you need to define:<\/p>\n<ul>\n<li><strong>Authentication<\/strong> &ndash; 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 <a href=\"\/docs\/bots\/bot-builder-tool\/alert\/notification-tasks\/#auth\">here<\/a>.<\/li>\n<li><strong>WSDL URL<\/strong> &ndash; 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, <a href=\"#Defining_the_WSDL_URL\">see below for details<\/a>.<\/li>\n<li><strong>Access Using a connector<\/strong> &ndash; Specify if your Bots Platform is installed on-premises and you want to user the Kore.ai Connector agent, <a href=\"#Access_Using_a_Connector\">see below for details<\/a>.<\/li>\n<li><strong>Response Sample<\/strong> &ndash; Define key\/value pairs that you expect to receive in the task payload. The keys that you provide are available as drop-down choices for handling the data to display to the end-user, <a href=\"#Adding_the_Response_Sample\">see below for details<\/a>.<\/li>\n<li><strong>Preview Website Link Content in Post<\/strong> &#8211; The website preview content displayed in the task notification message, <a href=\"#Website_Preview_Content\">see below for details<\/a>.<\/li>\n<\/ul>\n<p>Click <strong>Save<\/strong>&nbsp;to save the API request settings.<\/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<h2><span class=\"ez-toc-section\" id=\"Define_the_WSDL_URL\">Define the WSDL URL<\/span><\/h2>\n<ol>\n<ol>\n<li>On the&nbsp;<strong>API Request<\/strong>&nbsp;tab, expand the&nbsp;<strong>WSDL URL<\/strong>&nbsp;section<\/li>\n<li>To begin the request task configuration for a SOAP request, enter the URL for your SOAP WSDL in the&nbsp;<strong>WSDL URL<\/strong> field.<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145214\/expand-wsdl.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-45721\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145214\/expand-wsdl-1024x276.png\" alt=\"\" width=\"640\" height=\"173\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145214\/expand-wsdl-1024x276.png 1024w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145214\/expand-wsdl-300x81.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145214\/expand-wsdl.png 1606w\" sizes=\"auto, (max-width: 640px) 100vw, 640px\" \/><\/a><\/li>\n<li>Click&nbsp;<strong>Get WSDL Description<\/strong>. A&nbsp;list of&nbsp;<strong>available operators<\/strong>&nbsp;defined in the WSDL opens.<\/li>\n<li>Click <strong>Select&nbsp;<\/strong>for the SOAP request that you want to use for your task. Kore.ai will automatically populate one or more Alert Task Fields if necessary for user input.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145445\/wsdl-description.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-45724\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145445\/wsdl-description-1024x339.png\" alt=\"\" width=\"640\" height=\"212\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145445\/wsdl-description-1024x339.png 1024w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145445\/wsdl-description-300x99.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145445\/wsdl-description.png 1441w\" sizes=\"auto, (max-width: 640px) 100vw, 640px\" \/><\/a><\/li>\n<\/ol>\n<\/ol>\n<h2><span class=\"ez-toc-section\" id=\"Customize_SOAP_Alert_Task_Fields\">Customize SOAP Alert Task Fields<\/span><\/h2>\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>&nbsp;from your WSDL. To customize the default <strong>Alert Task&nbsp;Fields<\/strong>, click <strong>Edit<\/strong> for the <strong>Alert Task&nbsp;Field<\/strong> that you want to customize.<br \/><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145611\/customize-fields.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-45727\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145611\/customize-fields-1024x454.png\" alt=\"\" width=\"640\" height=\"284\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145611\/customize-fields-1024x454.png 1024w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145611\/customize-fields-300x133.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145611\/customize-fields.png 1418w\" sizes=\"auto, (max-width: 640px) 100vw, 640px\" \/><\/a><\/p>\n<p>The <strong>Set up Alert&nbsp;Task&nbsp;Field<\/strong> dialog is displayed as shown in the following illustration. <br \/><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145820\/field-setup.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-45730\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927145820\/field-setup.png\" alt=\"\" width=\"225\" height=\"460\" \/><\/a><\/p>\n<p>To define end-user fields for a task, specify the values for the parameters in the <strong>Set up Alert&nbsp;Task Field<\/strong> dialog as described in the following table.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: center\">Field Name<\/th>\n<th style=\"text-align: center\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Field Title<\/td>\n<td>The title of the task input&nbsp;field displayed in the end-user interface, for example, <span style=\"color: #0000ff\">Country.<\/span><\/td>\n<\/tr>\n<tr>\n<td>Help Hint<\/td>\n<td>The help text displayed below the task setting the title to describe the task, for example, <span style=\"color: #0000ff\">Enter the Country Name you want the Weather for<\/span>.<\/td>\n<\/tr>\n<tr>\n<td>Field Key<\/td>\n<td>A read-only key that represents the end-user input value that you want to collect, for example, <span style=\"color: #0000ff\">country<\/span>.<\/td>\n<\/tr>\n<tr>\n<td>Field Type<\/td>\n<td>\n<p>Specifies the type of task input&nbsp;field 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&nbsp;date format syntax&nbsp;for the end-user to define when the task&nbsp;is 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>&nbsp;&#8211; For example,&nbsp;<span style=\"color: #0000ff\">16-05-1999<\/span><\/li>\n<li><strong>MM-dd-YYYY<\/strong>&nbsp;&#8211; For example,&nbsp;<span style=\"color: #0000ff\">05-16-1999<\/span><\/li>\n<li><strong>dd-MM-YY<\/strong>&nbsp;&#8211; For example,&nbsp;<span style=\"color: #0000ff\">16-05-99<\/span><\/li>\n<li><strong>YYYY-MM-dd<\/strong> &#8211; For example,&nbsp;<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&nbsp;in the name you want to embroider.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Password &#8211; <\/strong><span style=\"font-weight: 400\">Displays a text box for the user to enter a password for the web service.<\/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>&nbsp;returned 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 <strong>Actions<\/strong> column for options.<\/p>\n<\/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>&nbsp;task notification. Define the following properties for a dynamically populated dropdown.\n<ul>\n<li><strong>Use Separate WDSL<\/strong> &#8211; Add the WDSL URL, then click <strong>Get WDSL Description<\/strong>. You can then follow the same steps mentioned below.<\/li>\n<li style=\"font-weight: 400\"><strong>Available Operations <\/strong><span style=\"font-weight: 400\">&#8211; If you will not use a separate WDSL,you can select a pre-existing operation. To do so, click <\/span><strong>Select <\/strong><span style=\"font-weight: 400\">in the <\/span><em><span style=\"font-weight: 400\">Action <\/span><\/em><span style=\"font-weight: 400\">column.<\/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; You can choose one of the following:\n<ul>\n<li><strong>GET<\/strong> &#8211; Specifies an HTTP Request GET method for the task&nbsp;field.<\/li>\n<li><strong>POST<\/strong> &#8211; Specifies an HTTP Request POST method for the task&nbsp;field.<\/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>Option 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>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&nbsp;input, 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>&nbsp;&#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&nbsp;URL defined for the task. For example, a list of projects for a <em>JIRA<\/em>&nbsp;task notification message. Define the following properties for a dynamically populated drop-down.\n<ul>\n<li style=\"font-weight: 400\"><strong>Use Separate WDSL <\/strong><span style=\"font-weight: 400\">&#8211; Add the WDSL URL, then click Get WDSL Description. You can then follow the same steps mentioned below.&nbsp;<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Available Operations <\/strong><span style=\"font-weight: 400\">&#8211; If you will not use a separate WDSL,you can select a pre-existing operation. To do so, click <\/span><strong>Select <\/strong><span style=\"font-weight: 400\">in the <\/span><em><span style=\"font-weight: 400\">Action <\/span><\/em><span style=\"font-weight: 400\">column.<\/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&nbsp;field.<\/li>\n<li><strong>POST<\/strong> &#8211; Specifies an HTTP Request POST method for the task&nbsp;field.<\/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<\/ul>\n<\/li>\n<li><strong>Email<\/strong> &#8211; Displays a text box for the end-user to input&nbsp;an email address. In the <strong>Placeholder<\/strong> field, enter the helpful hint to display to the end-user inside the text box.<\/li>\n<li><strong>Date &amp; Time<\/strong> &#8211; Displays a text box for the end-user to input&nbsp;a date with&nbsp;time. 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&nbsp;time 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&nbsp;Type<\/strong> &#8211; Select&nbsp;the data type of the parent input form element.<\/li>\n<li><strong>Add Nested Form Field<\/strong> &#8211; Click to add one or more nested form fields.<\/li>\n<\/ul>\n<\/li>\n<li><strong>File Upload<\/strong> &#8211; Displays end-user control to search for, and select a file to upload. When clicked, enter the <strong>File Upload Payload Key<\/strong>. When the <strong>File Upload Payload Key<\/strong> is defined, in the <strong>File Upload Payload Field Value<\/strong> drop-down list, select one of the following types:\n<ul>\n<li><strong>File Name<\/strong><\/li>\n<li><strong>File Size<\/strong><\/li>\n<li><strong>File Content Type<\/strong><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Data Type<\/td>\n<td>\n<p>Select one of these user input types:<\/p>\n<ul>\n<li><strong>String<\/strong> &#8211; Users can input any sequence of numbers, letters, or special characters.<\/li>\n<li><strong>Number<\/strong> &#8211; Users can input a number. No special characters are allowed.<\/li>\n<li><strong>Boolean<\/strong> &#8211; User can input a Boolean value of <span style=\"color: #0000ff\">true<\/span> or <span style=\"color: #0000ff\">false<\/span>.<\/li>\n<li><strong>Email<\/strong> &#8211; User can input a valid email address.<\/li>\n<li><strong>Object<\/strong> &#8211; Data from a Bot&nbsp;can be received as JSON objects, for example, as location details defined as:<br \/><span style=\"color: #0000ff\">&nbsp;&#8220;location&#8221; : {<br \/><\/span><span style=\"color: #0000ff\">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&#8220;lat&#8221; : 17.4374614,<br \/><\/span><span style=\"color: #0000ff\">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&#8220;lng&#8221; : 78.4482878<\/span><br \/><span style=\"color: #0000ff\">&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }<\/span><br \/>where you can refer to the properties in a request chain or task&nbsp;request 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 \/><span style=\"color: #0000ff\">&#8220;attendees&#8221;: [&#8220;user1&#8221;, &#8220;user2&#8221;, &#8220;user3&#8221;]<\/span>When selected, specify the <strong>Type<\/strong> for the array of end-user input as one of:\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&nbsp;<\/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&nbsp;field should be visible or hidden from the end-user.<br \/>The <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 <em>JIRA<\/em> bot, posting a comment on a ticket using an <span style=\"color: #0000ff\">@mention<\/span> tag as shown below:<br \/><span style=\"color: #0000ff\">&#8220;@Mike, please look into this issue&#8221;<\/span><br \/>The <em>JIRA<\/em> API to <em>Post a comment<\/em> 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 <em>JIRA<\/em> API to fetch data to append to the <code>comment<\/code> field value, but not to use as payload field or query field.<br \/>The default <strong>Visibility<\/strong> field setting is <strong>Visible<\/strong>.<\/p>\n<\/td>\n<\/tr>\n<tr>\n<td>Mandatory<\/td>\n<td>Select if the&nbsp;end-user must define this setting to save the task&nbsp;settings 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>&nbsp;to save the alert&nbsp;task&nbsp;field for the API request and create another alert&nbsp;task field, or click&nbsp;<strong>Add &amp; Exit<\/strong>&nbsp;to save the alert&nbsp;task field for the API&nbsp;request and close the dialog.<\/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<h2><span class=\"ez-toc-section\" id=\"Access_Using_a_Connector\">Access Using a Connector<\/span><\/h2>\n<p>To get started with defining access using a connector&nbsp;for 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> section.<\/li>\n<li>In the<strong> Access Using A Connector<\/strong>&nbsp;field, 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=\"\/docs\/bots\/admin-console\/security-control\/security-module-overview\/#Why_Use_the_Koreai_Connector_for_Bots\">Using the Kore.ai Connector<\/a>.<br \/><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927150828\/access-using-connector.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-large wp-image-45733\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927150828\/access-using-connector-1024x227.png\" alt=\"\" width=\"640\" height=\"142\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927150828\/access-using-connector-1024x227.png 1024w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927150828\/access-using-connector-300x67.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927150828\/access-using-connector.png 1059w\" sizes=\"auto, (max-width: 640px) 100vw, 640px\" \/><\/a><\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h2><span class=\"ez-toc-section\" id=\"Add_the_Response_Sample\">Add the Response Sample<\/span><\/h2>\n<p>In the <strong>Response Sample<\/strong>&nbsp;section, you can enter or paste examples of the key-value pairs that you expect to receive in the task payload.&nbsp;When you define the response sample, the keys specified&nbsp;in the&nbsp;<strong>Response Sample<\/strong>&nbsp;section are available as drop-down choices for handling the&nbsp;output data.Add the Sample Response<\/p>\n<ul>\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&nbsp;illustration, click the <strong>Formatted<\/strong> <img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-9801 size-full\" src=\"\/wp-content\/uploads\/sites\/35\/DIYFormattedIcon.png\" width=\"26\" height=\"26\" \/>&nbsp;icon.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/35\/Sample-response-indent.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14126\" src=\"\/wp-content\/uploads\/sites\/35\/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\/35\/DIYUnFormattedIcon.png\" width=\"26\" height=\"26\" \/><\/strong>&nbsp;icon.<\/li>\n<\/ul>\n<\/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=\"Website_Preview_Content\">Website Preview Content<\/span><\/h2>\n<p>Some web services send links to preview media as part of the payload response. In this section, you can enable or disable preview links, and define the path to the links in the payload. By default, website preview links are disabled. The following illustration is an example of the <strong>Preview Website Link Content in Post<\/strong> section, when <strong>Yes<\/strong> is selected.<\/p>\n<p><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927151033\/preview-website-link-content-in-post.png\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20220927151033\/preview-website-link-content-in-post.png\" alt=\"\" width=\"530\" height=\"512\" class=\"alignnone size-full wp-image-45736\" \/><\/a><\/p>\n<p>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&#8230; &#8220;item&#8221;: [ { &#8220;title&#8221;: &#8220;U.S. to Boost Refugee Intake by 30,000 by 2017&#8221;, &#8220;guid&#8221;: { &#8220;-isPermaLink&#8221;: &#8220;false&#8221;, &#8220;#text&#8221;: &#8220;SB12418904751422433479504581245034032986752&#8221; }, &#8220;link&#8221;: &#8220;http:\/\/www.wsj.com\/articles\/john-kerry-says-u-s-to-admit-30-000-more-refugees-in-next-2-years-1442768498?mod=fox_australian&#8221;, &#8230;When&nbsp;<strong>Preview website link content in Post<\/strong>&nbsp;is enabled, select&nbsp;preview 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;&nbsp;Enables display of image&nbsp;links from the website content.<\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"In this article, we will see how to configure an API Request for a SOAP service, as part of an Alert Task. Learn more about Alert tasks here. SOAP API Request Overview For a task with the&nbsp;Connection Type&nbsp;specified as Webservice&nbsp;and the Connection Mode set to&nbsp;SOAP&nbsp;you need to define: Authentication &ndash; If required for your alert...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[67],"tags":[],"class_list":["post-27054","post","type-post","status-publish","format-standard","hentry","category-alert"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/27054","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=27054"}],"version-history":[{"count":4,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/27054\/revisions"}],"predecessor-version":[{"id":45739,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/27054\/revisions\/45739"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=27054"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=27054"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=27054"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}