{"id":27054,"date":"2021-03-17T06:29:13","date_gmt":"2021-03-17T06:29:13","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-2\/?p=27054"},"modified":"2021-03-17T06:34:09","modified_gmt":"2021-03-17T06:34:09","slug":"alert-task-soap-api-request","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-2\/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>We have seen how an Alert task can be set up in Kore.ai virtual assistant platform\u00a0<a href=\"\/docs\/bots\/bot-builder-tool\/alert\/notification-tasks\/\" target=\"_blank\" rel=\"noopener noreferrer\">here<\/a>. In this section, we will see how to configure an API Request for a SOAP service.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p>For 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=\"\/docs\/bots\/bot-builder-tool\/alert\/notification-tasks\/#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, <a href=\"#Defining_the_WSDL_URL\">see below for details<\/a>.<\/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, <a href=\"#Access_Using_a_Connector\">see below for details<\/a>.<\/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 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>\u00a0to 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=\"Defining_the_WSDL_URL\">Defining the WSDL URL<\/span><\/h2>\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\/26\/WSDL-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14133\" src=\"\/wp-content\/uploads\/sites\/26\/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\/26\/Available-operators.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14186\" src=\"\/wp-content\/uploads\/sites\/26\/Available-operators.png\" alt=\"\" width=\"1070\" height=\"476\" \/><\/a><\/li>\n<\/ol>\n<h5>Customize 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\/26\/WSDL-edit-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14187\" src=\"\/wp-content\/uploads\/sites\/26\/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<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.<\/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\u00a0field displayed in the end-user interface, for example, <span style=\"color: #0000ff;\">Country.<\/span><\/td>\n<\/tr>\n<tr>\n<td>Help Hint<\/td>\n<td>The help text displayed below the task setting the title to describe the task, for example, <span style=\"color: #0000ff;\">Enter the Country Name you want the Weather for<\/span>.<\/td>\n<\/tr>\n<tr>\n<td>Field Key<\/td>\n<td>A read-only key that represents the end-user input value that you want to collect, for example, <span style=\"color: #0000ff;\">country<\/span>.<\/td>\n<\/tr>\n<tr>\n<td>Field Type<\/td>\n<td>\n<p>Specifies the type of task input\u00a0field displayed in the end-user interface to collect user input for the request object to assign to the <strong>Key<\/strong> value. The default setting is <strong>Textbox<\/strong>, but can be customized to any one of the following:<\/p>\n<ul>\n<li><strong>Date<\/strong> &#8211; Displays the <strong>Format<\/strong> field where you can select the\u00a0date format syntax\u00a0for the end-user to define when the task\u00a0is configured for their account. In the <strong>Select Date Format<\/strong> drop-down list, select one of the following:\n<ul>\n<li><strong>dd-MM-YYYY<\/strong>\u00a0&#8211; For example,\u00a0<span style=\"color: #0000ff;\">16-05-1999<\/span><\/li>\n<li><strong>MM-dd-YYYY<\/strong>\u00a0&#8211; For example,\u00a0<span style=\"color: #0000ff;\">05-16-1999<\/span><\/li>\n<li><strong>dd-MM-YY<\/strong>\u00a0&#8211; For example,\u00a0<span style=\"color: #0000ff;\">16-05-99<\/span><\/li>\n<li><strong>YYYY-MM-dd<\/strong> &#8211; For example,\u00a0<span style=\"color: #0000ff;\">1999-05-16<\/span><\/li>\n<\/ul>\n<\/li>\n<li><strong>URL<\/strong> &#8211; Displays a text box for the end-user to enter a URL including field validation for a correct URL syntax. In the <strong>Placeholder<\/strong> field, enter the help hint displayed in the text box, for example, <span style=\"color: #0000ff;\">Enter the URL for the website here.<\/span><\/li>\n<li><strong>Textbox<\/strong> &#8211; Displays a text box for the end-user to enter text as the task input field, typically just a few words. In the <strong>Placeholder<\/strong> field, enter the help hint displayed in the text field, for example, <span style=\"color: #0000ff;\">Type\u00a0in the name you want to embroider.<\/span><\/li>\n<li><strong>Static Dropdown<\/strong> &#8211; Displays a drop-down list of choices to the end-user. Click <strong>Add Option<\/strong> to begin adding the list of items to display to the end-user with the following parameters:\n<ul>\n<li><strong>Option Name <\/strong>&#8211; The name of the option displayed to the end-user.<\/li>\n<li><strong>Option Value<\/strong> &#8211; The value the represents the <strong>Option Name<\/strong>\u00a0returned to the application.<\/li>\n<li><strong>Default Value<\/strong> &#8211; Select the default value for the option when more than one option is defined.<\/li>\n<li><strong>Searchable<\/strong> &#8211; Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.<\/li>\n<\/ul>\n<p>Click <strong>Save<\/strong>. To add additional items, click <strong>Add Option<\/strong> again. Edit or remove options in the <b>Actions<\/b> column for options.<\/li>\n<li><strong>Dynamic Dropdown<\/strong> &#8211; Displays a drop-down list dynamically populated at runtime based on the response from a URL for your Bot, for example, a list of projects for a <em>JIRA<\/em>\u00a0task notification. Define the following properties for a dynamically populated dropdown.\n<ul>\n<li><strong>Endpoint URL<\/strong> &#8211; The Bot\u00a0endpoint URL, for example,\u00a0<span style=\"color: #0000ff;\">https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/li>\n<li><strong>Endpoint Content Type<\/strong> &#8211; The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, URL Encoded JSON, CCV, Text, or Twitter Encoded JSON.<\/li>\n<li><strong>Endpoint Method<\/strong> &#8211; One of:\n<ul>\n<li><strong>GET<\/strong> &#8211; Specifies an HTTP Request GET method for the task\u00a0field.<\/li>\n<li><strong>POST<\/strong> &#8211; Specifies an HTTP Request POST method for the task\u00a0field.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Response Path<\/strong> &#8211; The path in the response that contains the desired drop-down list values, for example, <span style=\"color: #0000ff;\">data<\/span>.<\/li>\n<li><strong>Label Key<\/strong> &#8211; The key for the label of the drop-down option, for example, <span style=\"color: #0000ff;\">name<\/span>.<\/li>\n<li><strong>Option Value Key<\/strong> &#8211; The key for the value of the drop-down option, for example, <span style=\"color: #0000ff;\">id<\/span>.<\/li>\n<li><strong>Add Payload Field<\/strong> &#8211; Click to add one or more fields from the response payload as options for the dynamic dropdown. For each payload field, enter the <strong>Payload field key<\/strong> and the <strong>Payload field value<\/strong>, and then click <strong>Save<\/strong>. Edit or delete payload fields in the <strong>Actions<\/strong> column.<\/li>\n<li><strong>Searchable<\/strong> &#8211; Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<ul>\n<li><strong>Textarea<\/strong> &#8211; Displays a text area box for the end-user to enter text as the task\u00a0input, typically for several sentences. In the <strong>Placeholder<\/strong> field, enter the help hint displayed inside the text area.<\/li>\n<li><strong>Type Ahead<\/strong>\u00a0&#8211; Displays a dynamically populated drop-down list of choices to the end-user at runtime when the user enters three or more characters that match the search results based on the response from the\u00a0URL defined for the task. For example, a list of projects for a <em>JIRA<\/em>\u00a0task notification message. Define the following properties for a dynamically populated drop-down.\n<ul>\n<li><strong>Endpoint URL<\/strong> &#8211; The Bot\u00a0endpoint URL, for example,\u00a0<span style=\"color: #0000ff;\">https:\/\/app.asana.com\/api\/1.0\/workspaces<\/span>.<\/li>\n<li><strong>Endpoint Content Type<\/strong> &#8211; The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, URL Encoded JSON, CCV, Text, Twitter Encoded JSON, Multipart\/Form-data, or Multipart\/Related.<\/li>\n<li><strong>Endpoint Method<\/strong> &#8211; One of:\n<ul>\n<li><strong>GET<\/strong> &#8211; Specifies an HTTP Request GET method for the task\u00a0field.<\/li>\n<li><strong>POST<\/strong> &#8211; Specifies an HTTP Request POST method for the task\u00a0field.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Response Path<\/strong> &#8211; The path in the response that contains the desired drop-down list values, for example, <span style=\"color: #0000ff;\">data<\/span>.<\/li>\n<li><strong>Label Key<\/strong> &#8211; The key for the label of the drop-down option, for example, <span style=\"color: #0000ff;\">name<\/span>.<\/li>\n<li><strong>Option Value Key<\/strong> &#8211; The key for the value of the drop-down option, for example, <span style=\"color: #0000ff;\">id<\/span>.<\/li>\n<li><strong>Add Payload Field<\/strong> &#8211; Click to add one or more fields from the response payload as options for the type ahead field. For each type ahead field option, enter the <strong>Payload field key<\/strong> and the <strong>Payload field value<\/strong>, and then click <strong>Save<\/strong>. Edit or delete payload fields in the <strong>Actions<\/strong> column.<\/li>\n<li><strong>Editable<\/strong> &#8211; Enables the end-user to enter text free-from in the field as an option when type-ahead search results do not match.<\/li>\n<\/ul>\n<\/li>\n<li><strong>Email<\/strong> &#8211; Displays a text box for the end-user to input\u00a0an email address. In the <strong>Placeholder<\/strong> field, enter the 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\u00a0a date with\u00a0time. In the <strong>Format<\/strong> field, enter the expected date or time format to display to the end-user in the date text box. In the <strong>Select Date Format<\/strong> drop-down list, select the date with\u00a0time format.<\/li>\n<li><strong>Time Zone<\/strong> &#8211; Displays a drop-down list of time zones based on the operating system settings.<\/li>\n<li><strong>Location<\/strong> &#8211; Displays a text box for the end-user to enter a geographical location, for example, <span style=\"color: #0000ff;\">Orlando, FL<\/span>, or <span style=\"color: #0000ff;\">32801<\/span>.<\/li>\n<li><strong>Nested Form<\/strong> &#8211; Displays end-user input fields in a nested format below the parent input field. Specify the following fields for a nested form input field:\n<ul>\n<li><strong>Array Element\u00a0Type<\/strong> &#8211; Select\u00a0the data type of the parent input form element.<\/li>\n<li><strong>Add Nested Form Field<\/strong> &#8211; Click to add one or more nested form fields.<\/li>\n<\/ul>\n<\/li>\n<li><strong>File Upload<\/strong> &#8211; Displays end-user control to search for, and select a file to upload. When clicked, enter the <strong>File Upload Payload Key<\/strong>. When the <strong>File Upload Payload Key<\/strong> is defined, in the <strong>File Upload Payload Field Value<\/strong> drop-down list, select one of the following types:\n<ul>\n<li><strong>File Name<\/strong><\/li>\n<li><strong>File Size<\/strong><\/li>\n<li><strong>File Content Type<\/strong><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Data Type<\/td>\n<td>\n<p>Select one of these user input types:<\/p>\n<ul>\n<li><strong>String<\/strong> &#8211; Users can input any sequence of numbers, letters, or special characters.<\/li>\n<li><strong>Number<\/strong> &#8211; Users can input a number. No special characters are allowed.<\/li>\n<li><strong>Boolean<\/strong> &#8211; User can input a Boolean value of <span style=\"color: #0000ff;\">true<\/span> or <span style=\"color: #0000ff;\">false<\/span>.<\/li>\n<li><strong>Email<\/strong> &#8211; User can input a valid email address.<\/li>\n<li><strong>Object<\/strong> &#8211; Data from a Bot\u00a0can be received as JSON objects, for example, as location details defined as:<br \/>\n<span style=\"color: #0000ff;\">\u00a0&#8220;location&#8221; : {<br \/>\n<\/span><span style=\"color: #0000ff;\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0&#8220;lat&#8221; : 17.4374614,<br \/>\n<\/span><span style=\"color: #0000ff;\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0&#8220;lng&#8221; : 78.4482878<\/span><br \/>\n<span style=\"color: #0000ff;\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/span><br \/>\nwhere you can refer to the properties in a request chain or task\u00a0request as <span style=\"color: #0000ff;\">location.lat<\/span>, and <span style=\"color: #0000ff;\">location.lng<\/span>.<\/li>\n<li><strong>Array<\/strong> &#8211; Users can pass a comma-separated list of values to the Bot. For example, in <em>Google Calendar<\/em>, multiple attendees with data can be passed as:<br \/>\n<span style=\"color: #0000ff;\">&#8220;attendees&#8221;: [&#8220;user1&#8221;, &#8220;user2&#8221;, &#8220;user3&#8221;]<br \/>\n<\/span>When selected, specify the <strong>Type<\/strong> for the array of end-user input as one of:<\/p>\n<ul>\n<li><strong>String<\/strong><\/li>\n<li><strong>Number<\/strong><\/li>\n<li><strong>Boolean<\/strong><\/li>\n<li><strong>Email<\/strong><\/li>\n<li><strong>Array<\/strong><\/li>\n<li><strong>Date<\/strong><\/li>\n<\/ul>\n<\/li>\n<li><strong>Date<\/strong> &#8211; Users can type a complete date or select <span style=\"background-color: #f6d5d9;\">it\u00a0<\/span>from a date picker.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Placeholder<\/td>\n<td>The text displayed below the input textbox to help the user define the field. This field is only displayed for some <strong>Field Types<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>Visibility<\/td>\n<td>Specify if the task input\u00a0field should be visible or hidden from the end-user.<br \/>\nThe <strong>Visibility<\/strong> field can also be set to <strong>Custom<\/strong> field where data is captured from the user but not used as a query parameter or payload field. For example, with a <i>JIRA<\/i> bot, posting a comment on a ticket using an <span style=\"color: #0000ff;\">@mention<\/span> tag as shown below:<br \/>\n<span style=\"color: #0000ff;\">&#8220;@Mike, please look into this issue&#8221;<\/span><br \/>\nThe <i>JIRA<\/i> API to <i>Post a comment<\/i> requires one query field and one payload field as:<\/p>\n<ul>\n<li>Issue ID<\/li>\n<li>Comment<\/li>\n<\/ul>\n<p>With the <strong>Visibility<\/strong> field set to <strong>Custom<\/strong>, you can capture the user information for the user mentioned as <code>@Mike<\/code> using the <i>JIRA<\/i> API to fetch data to append to the <code>comment<\/code> field value, but not to use as payload field or query field.<br \/>\nThe default <strong>Visibility<\/strong> field setting is <strong>Visible<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>Mandatory<\/td>\n<td>Select if the\u00a0end-user must define this setting to save the task\u00a0settings configuration.<\/td>\n<\/tr>\n<tr>\n<td>Untranspose the Key<\/td>\n<td>Select to disable key transposition by Kore.ai. By default, Kore.ai transposes a key\/value pair, for example, <code>\"parameter\":\"value\"<\/code> is transposed by Kore.ai to <code>\"parameter:{value:\"actualValue\"}<\/code>. When selected, keys are not transposed by Kore.ai and passed in the response as received.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\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\u00a0for a task, follow these steps:<\/p>\n<ul>\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\/26\/Access-using-a-connector.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14139\" src=\"\/wp-content\/uploads\/sites\/26\/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=\"\/docs\/bots\/admin-console\/security-control\/security-module-overview\/#Why_Use_the_Koreai_Connector_for_Bots\">Using the Kore.ai Connector<\/a>.<\/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=\"Adding_the_Response_Sample\">Adding the Response Sample<\/span><\/h2>\n<p>In 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.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\u00a0illustration, click the <strong>Formatted<\/strong> <img loading=\"lazy\" decoding=\"async\" class=\"icon alignnone wp-image-9801 size-full\" src=\"\/wp-content\/uploads\/sites\/26\/DIYFormattedIcon.png\" width=\"26\" height=\"26\" \/>\u00a0icon.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/26\/Sample-response-indent.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-14126\" src=\"\/wp-content\/uploads\/sites\/26\/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\/26\/DIYUnFormattedIcon.png\" width=\"26\" height=\"26\" \/><\/strong>\u00a0icon.<\/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.<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/26\/DIYActionTaskRESTAPIRequestTabPreview.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-9950\" src=\"\/wp-content\/uploads\/sites\/26\/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&#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\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\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":"We have seen how an Alert task can be set up in Kore.ai virtual assistant platform\u00a0here. In this section, we will see how to configure an API Request for a SOAP service. For a task with the\u00a0Connection Type\u00a0specified as Webservice\u00a0and the Connection Mode set to\u00a0SOAP\u00a0you need to define: Authentication \u2013 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\/v9-2\/wp-json\/wp\/v2\/posts\/27054","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/comments?post=27054"}],"version-history":[{"count":2,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/posts\/27054\/revisions"}],"predecessor-version":[{"id":27062,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/posts\/27054\/revisions\/27062"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/media?parent=27054"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/categories?post=27054"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/tags?post=27054"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}