{"id":17959,"date":"2016-12-09T21:59:11","date_gmt":"2016-12-09T21:59:11","guid":{"rendered":"https:\/\/developer.kore.com\/?post_type=docs&#038;p=9252"},"modified":"2021-08-04T07:38:53","modified_gmt":"2021-08-04T06:38:53","slug":"working-with-the-web-hook-node","status":"publish","type":"post","link":"https:\/\/multisite.korebots.com\/v9-0\/docs\/bots\/bot-builder-tool\/dialog-task\/working-with-the-web-hook-node\/","title":{"rendered":"WebHook Node"},"content":{"rendered":"<section class=\"l-section wpb_row height_auto\"><div class=\"l-section-h i-cf\"><div class=\"g-cols vc_row via_grid cols_1 laptops-cols_inherit tablets-cols_inherit mobiles-cols_1 valign_top type_default stacking_default\"><div class=\"wpb_column vc_column_container\"><div class=\"vc_column-inner\"><div class=\"wpb_text_column\"><div class=\"wpb_wrapper\"><p>You can use the WebHook node to subscribe to a message and WebHook events to capture real-time data from real-time events and show them to the user. You can use the WebHook node for server-side validation, execute business logic, or make backend server API calls. Also, you can use the Kore.ai SDK Tool BotKit to add event handlers, control the messages and WebHook events as required by connecting the WebHook node to a script node to process the response.<\/p>\n<\/div><\/div><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 class=\"wpb_text_column\"><div class=\"wpb_wrapper\"><h2 id=\"webhook\"><span class=\"ez-toc-section\" id=\"Create_and_Register_an_App\"><\/span>Create and Register an App<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>To get access to WebHook events and use WebHook nodes in your dialog task, you need to subscribe and configure an app in the <b>Deploy -&gt; Integrations<\/b> tab of your Bot. For more information, refer to <a href=\"\/docs\/bots\/bot-builder\/editing-an-existing-bot\/sdk-configuration\/\">SDK Configuration<\/a>.<\/p>\n<ol>\n<li>Select the\u00a0<strong>Deploy<\/strong> tab from the top menu<\/li>\n<li>On the left menu, click <b>Integrations -&gt;<\/b>\u00a0<strong>Agent Transfer<\/strong>.<\/li>\n<li>On the Agent Transfer page, click <strong>Add<\/strong> next to the <strong>App Name<\/strong> drop-down list.<\/li>\n<li>On the <strong>Create Client App <\/strong>window, enter the app name in the <strong>Name<\/strong> field. For example, SDK App.<\/li>\n<li>Click <strong>Next<\/strong>.<\/li>\n<li>The <strong>Client ID<\/strong> and <strong>Client Secret<\/strong> are generated along with the <em>App Created Successfully<\/em> message.<\/li>\n<li>Click <strong>Done<\/strong>.<\/li>\n<li>In the <strong>Callback URL<\/strong> field, enter the URL for your application that you want Kore.ai to push data to. For example, https:\/\/koremessenger.com\/postURL.<br \/>\n<b>Note<\/b>: The registration app you create is based on the <b>Callback URL<\/b> applicable to all tasks for the bot. While each task can have unique SDK configurations, the <b>Callback URL<\/b> is the same. Create separate bots for separate application <b>Callback URLs<\/b> for live agent transfers.<\/li>\n<li>Under the <strong>PII Data<\/strong> section, define how <strong>sensitive information<\/strong> should be handled. If there is a need to share unmasked data when an agent session is in progress, even when <a href=\"\/docs\/bots\/bot-settings\/pii-data-masking\/\">PII redaction is enabled<\/a>, select the <em>Do not mask and send original data to Agent BotKit<\/em>. Else, go with the default setting of <em>Mask and send sensitive data to Agent BotKit.<\/em><\/li>\n<li>Under the <strong>Access Using a Connector<\/strong> section, indicate if your URL is behind a firewall and a <strong>Connector<\/strong> has to be used.<\/li>\n<li>Click <b>Save<\/b>. The <i>Successfully subscribed<\/i> message is displayed.<\/li>\n<\/ol>\n<p><a ref=\"magnificPopup\" href=\"https:\/\/s3-us-east-2.amazonaws.com\/kore-wordpress\/developer.kore.ai\/wp-content\/uploads\/sites\/22\/20210706111903\/webHook_app.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-28323\" src=\"https:\/\/s3-us-east-2.amazonaws.com\/kore-wordpress\/developer.kore.ai\/wp-content\/uploads\/sites\/22\/20210706111903\/webHook_app.png\" alt=\"\" width=\"1366\" height=\"768\" \/><\/a><\/p>\n<\/div><\/div><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 class=\"wpb_text_column\"><div class=\"wpb_wrapper\"><h2><span class=\"ez-toc-section\" id=\"Set-Up\"><\/span>Set-Up<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>Setting up a Webhook node in a dialog task involves the following steps:<\/p>\n<p>Note: Post v9.0 of the platform, the Service node is categorized under the Bot Action node. For details on the Bot Action node,\u00a0<a href=\"\/docs\/bots\/bot-builder-tool\/dialog-task\/bot-action-node\/\" target=\"_blank\" rel=\"noopener noreferrer\">click here<\/a>.<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Add_Node\"><\/span>Add Node<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<ol>\n<li>Open the dialog task to add the Webhook node.<\/li>\n<li>Add Webhook node in the designated place. For steps in adding nodes, <a href=\"\/docs\/bots\/chatbot-overview\/using-the-dialog-builder-tool\/#Adding_Nodes\">refer here<\/a>.<\/li>\n<li>The Webhook window is displayed with the <strong>Component Properties<\/strong> tab selected by default.<\/li>\n<li>You can configure the <strong>Connection Properties, <\/strong><a href=\"\/docs\/bots\/chatbot-overview\/using-the-dialog-builder-tool\/#Bot_Action_Nodes\" target=\"_blank\" rel=\"noopener noreferrer\">refer here for details<\/a>.<\/li>\n<\/ol>\n<\/div><\/div><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>[vc_raw_html]JTNDZGl2JTIwY2xhc3MlM0QlMjJ3LXBvc3QtZWxtJTIwcG9zdF9uYXZpZ2F0aW9uJTIwbGF5b3V0X3NpbXBsZSUyMGludl9mYWxzZSUyMiUzRSUwQSUwOSUzQ2ElMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtJTIwb3JkZXJfZmlyc3QlMjB0b19wcmV2JTIyJTIwaHJlZiUzRCUyMiUyRmRvY3MlMkZib3RzJTJGYm90LWJ1aWxkZXItdG9vbCUyRmRpYWxvZy10YXNrJTJGd29ya2luZy13aXRoLXRoZS1hZ2VudC10cmFuc2Zlci1ub2RlJTJGJTIyJTNFJTNDJTJGcCUzRSUwQSUzQ2RpdiUyMGNsYXNzJTNEJTIycG9zdF9uYXZpZ2F0aW9uLWl0ZW0tYXJyb3clMjIlM0UlM0MlMkZkaXYlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLW1ldGElMjIlM0VQcmV2aW91cyUzQyUyRmRpdiUzRSUwQSUzQ2RpdiUyMGNsYXNzJTNEJTIycG9zdF9uYXZpZ2F0aW9uLWl0ZW0tdGl0bGUlMjIlM0UlM0NzcGFuJTNFQWdlbnQlMjBUcmFuc2ZlciUyME5vZGVzJTNDJTJGc3BhbiUzRSUzQyUyRmRpdiUzRSUwQSUzQ3AlM0UlM0MlMkZhJTNFJTNDYnIlMjAlMkYlM0UlMEElM0NhJTIwY2xhc3MlM0QlMjJwb3N0X25hdmlnYXRpb24taXRlbSUyMG9yZGVyX3NlY29uZCUyMHRvX25leHQlMjIlMjBocmVmJTNEJTIyJTJGZG9jcyUyRmJvdHMlMkZib3QtYnVpbGRlci10b29sJTJGZGlhbG9nLXRhc2slMkZncm91cGluZy1ub2RlcyUyRiUyMiUzRSUzQyUyRnAlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLWFycm93JTIyJTNFJTNDJTJGZGl2JTNFJTBBJTNDZGl2JTIwY2xhc3MlM0QlMjJwb3N0X25hdmlnYXRpb24taXRlbS1tZXRhJTIyJTNFTmV4dCUzQyUyRmRpdiUzRSUwQSUzQ2RpdiUyMGNsYXNzJTNEJTIycG9zdF9uYXZpZ2F0aW9uLWl0ZW0tdGl0bGUlMjIlM0UlM0NzcGFuJTNFR3JvdXBpbmclMjBOb2RlcyUzQyUyRnNwYW4lM0UlM0MlMkZkaXYlM0UlMEElM0NwJTNFJTNDJTJGYSUzRSUzQyUyRmRpdiUzRQ==[\/vc_raw_html]<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><\/section>\n","protected":false},"excerpt":{"rendered":"You can use the WebHook node to subscribe to a message and WebHook events to capture real-time data from real-time events and show them to the user. You can use the WebHook node for server-side validation, execute business logic, or make backend server API calls. Also, you can use the Kore.ai SDK Tool BotKit to...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[29],"tags":[],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts\/17959"}],"collection":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/comments?post=17959"}],"version-history":[{"count":21,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts\/17959\/revisions"}],"predecessor-version":[{"id":29420,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/posts\/17959\/revisions\/29420"}],"wp:attachment":[{"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/media?parent=17959"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/categories?post=17959"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/multisite.korebots.com\/v9-0\/wp-json\/wp\/v2\/tags?post=17959"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}