{"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":"2021-03-25T17:20:59","modified_gmt":"2021-03-25T17:20:59","slug":"working-with-the-web-hook-node","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/bot-builder-tool\/dialog-task\/working-with-the-web-hook-node\/","title":{"rendered":"Working with the 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 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\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 Settings<\/b> tab of your Bot. For more information, refer to SDK Configuration<\/a>.<\/p>\n

    \n
  1. On the left pane, click API Extensions<\/b>.\u00a0By default, the BotKit SDK tab is displayed.<\/li>\n
  2. Click Agent 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 bot. While each task can have unique SDK configurations, the Callback URL<\/b> is the same. Create separate bots 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>. Else, go with the default setting of Mask and send sensitive data to 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\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 the WebHook Node<\/span><\/h2>\n

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

    Add a WebHook Node to the Dialog Task<\/span><\/h3>\n
      \n
    1. Open the dialog task to add the <\/span>WebHook node.<\/li>\n
    2. Click the +<\/strong> <\/span>icon next to the respective node.<\/span><\/li>\n
    3. Select Intent <\/b>> New WebHook Node<\/b>.<\/li>\n
    4. On the WebHook window, by default, the Component Properties<\/strong> tab is displayed.<\/span><\/li>\n
    5. Enter a Name<\/strong> and Display Name<\/strong> for the node.<\/span><\/li>\n
    6. The other settings are auto-filled based on your Agent Transfer SDK configuration. Go to API Extensions<\/b> to modify any settings.<\/li>\n
    7. In the Variable Namespaces<\/strong> section (introduced in v8.0), associate the Variable Namespaces to execute this node and its transitions. This option is visible only when the Variable Namespace is enabled for the bot. You can go with the task level settings or customize it for this node. For more information, refer to Managing Namespace<\/a>.<\/li>\n<\/ol>\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

      Configure the Connections Properties<\/span><\/h3>\n

      You can add If-Else<\/em> operators in the node\u2019s Connections<\/strong> tab to determine which node in the dialog text to execute next. You can write the conditional statements based on the values of any Entity or Context Objects in the dialog task, or you can use intents for transitions.
      \nTo set up Component Transitions, follow the below steps:<\/p>\n

        \n
      1. Click the Connections<\/strong> tab.<\/li>\n
      2. On the Connections tab, under the Connection Rules<\/strong> section, click Add IF<\/b>.<\/li>\n
      3. Configure the conditional expression based on one of the following criteria:\n