{"id":17959,"date":"2016-12-09T21:59:11","date_gmt":"2016-12-09T21:59:11","guid":{"rendered":"https:\/\/developer.kore.com\/?post_type=docs&p=9252"},"modified":"2022-04-25T10:07:24","modified_gmt":"2022-04-25T09:07:24","slug":"working-with-the-web-hook-node","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-2\/docs\/bots\/bot-builder-tool\/dialog-task\/working-with-the-web-hook-node\/","title":{"rendered":"WebHook Node"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

You can use the WebHook node to subscribe to a message and WebHook events to capture real-time data from real-time events to 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\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Create and Register an App<\/span><\/h2>\n

To get access to WebHook events and use WebHook nodes in your dialog task, you need to subscribe and configure an app in the Deploy -> Integrations<\/b> tab of your Virtual Assistant. For more information, refer to SDK Configuration<\/a>.<\/p>\n

    \n
  1. Select the\u00a0Deploy<\/strong> tab from the top menu<\/li>\n
  2. On the left menu, click Integrations -><\/b>\u00a0Agent Transfer<\/strong>.<\/li>\n
  3. On the Agent Transfer page, click Add<\/strong> next to the App Name<\/strong> drop-down list.<\/li>\n
  4. On the Create Client App <\/strong>window, enter the app name in the Name<\/strong> field. For example, SDK App.<\/li>\n
  5. Click Next<\/strong>.<\/li>\n
  6. The Client ID<\/strong> and Client Secret<\/strong> are generated along with the App Created Successfully<\/em> message.<\/li>\n
  7. Click Done<\/strong>.<\/li>\n
  8. In the 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.
    \nNote<\/b>: The registration app you create is based on the Callback URL<\/b> applicable to all tasks for the VA. While each task can have unique SDK configurations, the Callback URL<\/b> is the same. Create separate Virtual Assistants for separate application Callback URLs<\/b> for live agent transfers.<\/li>\n
  9. Under the PII Data<\/strong> section, define how sensitive information<\/strong> should be handled. If there is a need to share unmasked data when an agent session is in progress, even when PII redaction is enabled<\/a>, select the Do not mask and send original data to Agent BotKit<\/em>. or else, go with the default setting of Mask and send sensitive data Agent BotKit.<\/em><\/li>\n
  10. Under the Access Using a Connector<\/strong> section, indicate if your URL is behind a firewall and a Connector<\/strong> has to be used.<\/li>\n
  11. Click Save<\/b>. The Successfully subscribed<\/i> message is displayed.<\/li>\n<\/ol>\n

    \"\"<\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Set-Up<\/span><\/h2>\n

    Setting up a Webhook node in a dialog task involves the following steps:<\/p>\n

    Note: Post v9.0 of the platform, the Service node is categorized under the VA Action node. For details on the VA Action node,\u00a0click here<\/a>.<\/p>\n

    Add Node<\/span><\/h3>\n
      \n
    1. Open the dialog task to add the Webhook node.<\/li>\n
    2. Add the Webhook node in the designated place. For steps in adding nodes, refer here<\/a>.<\/li>\n
    3. The Webhook window is displayed with the Component Properties<\/strong> tab selected by default.<\/li>\n
    4. You can configure the Connection Properties, <\/strong>refer here for details<\/a>.<\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
      <\/div><\/div>[vc_raw_html]JTNDZGl2JTIwY2xhc3MlM0QlMjJ3LXBvc3QtZWxtJTIwcG9zdF9uYXZpZ2F0aW9uJTIwbGF5b3V0X3NpbXBsZSUyMGludl9mYWxzZSUyMiUzRSUwQSUwOSUzQ2ElMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtJTIwb3JkZXJfZmlyc3QlMjB0b19wcmV2JTIyJTIwaHJlZiUzRCUyMiUyRmRvY3MlMkZib3RzJTJGYm90LWJ1aWxkZXItdG9vbCUyRmRpYWxvZy10YXNrJTJGd29ya2luZy13aXRoLXRoZS1hZ2VudC10cmFuc2Zlci1ub2RlJTJGJTIyJTNFJTNDJTJGcCUzRSUwQSUzQ2RpdiUyMGNsYXNzJTNEJTIycG9zdF9uYXZpZ2F0aW9uLWl0ZW0tYXJyb3clMjIlM0UlM0MlMkZkaXYlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLW1ldGElMjIlM0VQcmV2aW91cyUzQyUyRmRpdiUzRSUwQSUzQ2RpdiUyMGNsYXNzJTNEJTIycG9zdF9uYXZpZ2F0aW9uLWl0ZW0tdGl0bGUlMjIlM0UlM0NzcGFuJTNFQWdlbnQlMjBUcmFuc2ZlciUyME5vZGVzJTNDJTJGc3BhbiUzRSUzQyUyRmRpdiUzRSUwQSUzQ3AlM0UlM0MlMkZhJTNFJTNDYnIlMjAlMkYlM0UlMEElM0NhJTIwY2xhc3MlM0QlMjJwb3N0X25hdmlnYXRpb24taXRlbSUyMG9yZGVyX3NlY29uZCUyMHRvX25leHQlMjIlMjBocmVmJTNEJTIyJTJGZG9jcyUyRmJvdHMlMkZib3QtYnVpbGRlci10b29sJTJGZGlhbG9nLXRhc2slMkZncm91cGluZy1ub2RlcyUyRiUyMiUzRSUzQyUyRnAlM0UlMEElM0NkaXYlMjBjbGFzcyUzRCUyMnBvc3RfbmF2aWdhdGlvbi1pdGVtLWFycm93JTIyJTNFJTNDJTJGZGl2JTNFJTBBJTNDZGl2JTIwY2xhc3MlM0QlMjJwb3N0X25hdmlnYXRpb24taXRlbS1tZXRhJTIyJTNFTmV4dCUzQyUyRmRpdiUzRSUwQSUzQ2RpdiUyMGNsYXNzJTNEJTIycG9zdF9uYXZpZ2F0aW9uLWl0ZW0tdGl0bGUlMjIlM0UlM0NzcGFuJTNFR3JvdXBpbmclMjBOb2RlcyUzQyUyRnNwYW4lM0UlM0MlMkZkaXYlM0UlMEElM0NwJTNFJTNDJTJGYSUzRSUzQyUyRmRpdiUzRQ==[\/vc_raw_html]
      <\/div><\/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 to 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":[],"class_list":["post-17959","post","type-post","status-publish","format-standard","hentry","category-dialog-task"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/posts\/17959","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=17959"}],"version-history":[{"count":12,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/posts\/17959\/revisions"}],"predecessor-version":[{"id":41546,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/posts\/17959\/revisions\/41546"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/media?parent=17959"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/categories?post=17959"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-2\/wp-json\/wp\/v2\/tags?post=17959"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}