{"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":"2023-12-18T11:27:38","modified_gmt":"2023-12-18T11:27:38","slug":"working-with-the-web-hook-node","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-builder-tool\/dialog-task\/working-with-the-web-hook-node\/","title":{"rendered":"WebHook Node"},"content":{"rendered":"

You can use the WebHook node to subscribe to a message and to WebHook events that 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.<\/span><\/p>\n

<\/div><\/div>\n

Create and Register an App<\/span><\/span><\/h1>\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 <\/span>Deploy > Integrations<\/strong> tab of your Virtual Assistant. For more information, refer to <\/span>SDK Configuration<\/span><\/a>. Let us use the example of an Agent Transfer app.<\/span><\/p>\n

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

    \"\"<\/a>
    \n

    <\/div><\/div>\n

    Add the Node<\/span><\/span><\/h1>\n

    Webhook Nodes can only be added as part of a Bot Action node. Therefore, before you can add a Webhook Node, you need to add a Bot Action node.<\/span><\/p>\n\n\n\n
    Note<\/strong>: Post v9.0 of the Platform, the Webhook node is categorized under the Bot Action node. For details on the Bot Action node<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

     <\/p>\n

    Keeping this in mind, the setup a Webhook node in a dialog task involves the following steps:<\/span><\/p>\n

      \n
    1. Open the dialog task to add the Webhook node.<\/span><\/li>\n
    2. Create and\/or expand a Bot Action node.<\/span><\/li>\n
    3. Add a Webhook node in the designated place. For steps related to adding nodes, <\/span>refer here<\/span><\/a>.<\/span><\/li>\n
    4. The Webhook window is displayed with the <\/span>Component Properties<\/strong> tab selected by default.<\/span><\/li>\n
    5. To connect a Webhook node to a node outside of its containing Bot Action node, please read our article about the <\/span>Bot Action Node<\/span><\/a>.<\/span><\/li>\n<\/ol>\n

      \"\"<\/a>
      \n

      <\/div><\/div>\n

      Configure the Node<\/span><\/span><\/h1>\n
      <\/div><\/div>\n

      Component Properties<\/span><\/span><\/h2>\n\n\n\n
      Notes<\/strong>:<\/p>\n
        \n
      1. All changes made to the Component Properties tab will affect all instances of the Webhook Node, across Dialog Tasks.<\/li>\n
      2. If you have not yet configured the SDK, the Component Properties section will notify you that the SDK is not currently configured\/Subscribed. Please go to API Extensions to configure the SDK.<\/li>\n<\/ol>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

         <\/p>\n

        To configure the Component Properties tab, please follow the steps below:<\/span><\/p>\n

          \n
        1. On the <\/span>Component Properties<\/strong> tab, under the <\/span>General Settings<\/strong> section, enter the <\/span>Name<\/strong> and <\/span>Display Name<\/strong> of your Webhook node.\u00a0<\/span><\/li>\n
        2. In the <\/span>Variable Namespaces<\/strong> section, associate the variable namespaces to execute this node and its transitions. This option is visible only when the Variable Namespace is enabled for the VA. You can go with the task level settings or customize it for this node. For more information, refer to <\/span>Managing Namespace<\/span><\/a>.<\/span><\/li>\n<\/ol>\n

          \"\"<\/a>
          \n

          <\/div><\/div>\n

          Instance Properties<\/span><\/span><\/h2>\n

          Use the Instance Properties to define any user tags that you want to set for the Webhook node.<\/span><\/p>\n\n\n\n
          Note<\/strong>: The settings in the Instance Properties tab are specific to the current dialog task and do not reflect in other dialog tasks that use this node.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

           <\/p>\n

            \n
          1. On the Webhook node properties panel, click the <\/span>Instance Properties<\/strong> tab.<\/span><\/li>\n
          2. Under the <\/span>Custom<\/strong> Tags <\/strong>section, add tags to build custom profiles of your VA\u2019s conversations. <\/span>Click here for more<\/span><\/a>.<\/span><\/li>\n<\/ol>\n

            \"\"<\/a>
            \n

            <\/div><\/div>\n

            Connections Properties<\/span><\/span><\/h2>\n

            Since they are contained within Bot Action nodes, Webhook nodes cannot be connected on their own to any other nodes outside the Bot Action node to which they belong. Connections can only be made with nodes contained within the same Bot Action node.\u00a0<\/span><\/p>\n

            From the node\u2019s <\/span>Connection Properties <\/strong>tab, you can configure the following:<\/span><\/p>\n