{"id":18046,"date":"2018-05-04T07:47:19","date_gmt":"2018-05-04T07:47:19","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-1\/?post_type=docs&p=13873"},"modified":"2021-07-22T05:05:07","modified_gmt":"2021-07-22T04:05:07","slug":"adding-webhook-channel","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-1\/docs\/bots\/channel-enablement\/adding-webhook-channel\/","title":{"rendered":"Adding WebHook as a channel"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Webhook channel provides a generic webhook integration to connect your bot with any external communication systems. Kore.ai platform provides standard request and response APIs to send and receive text messages. End user\u2019s input through a voice, keypad, or any other means must be converted to plain text before it is sent to the Kore.ai platform using the request API.<\/p>\n

NOTE: From v7.0, you can enable multiple WebHook channels to your bot. Once added, the WebHook channel will not be disabled from the channel list and you can use the same process to enable another WebHook channel with a different name. Webhook channels with the name and type mentioned (webhook ) are available in the channels filter on the dashboard<\/em> and analyze<\/em> section to views the metrics on the applied channel. You can apply channel-specific overrides for each of the webhook channels created\/enabled – channel selection drop shows all the webhook channels created. Further, all the channels will be available for selection during the bot deployment.<\/p>\n

Prerequisites<\/span><\/h2>\n

To enable the Webhook channel for your Kore.ai bot, you must:<\/p>\n

    \n
  1. Associate App <\/b>– To enable the Webhook channel for your Kore.ai bot, you must associate the channel with either an existing app in your Kore.ai account or create a new app.<\/li>\n
  2. Select Integration Mode<\/b> – Enable an integration mode that is supported by the channel based on your business requirement. You can copy the Webhook URL<\/em> from the Configurations<\/strong> tab of the channel.<\/li>\n
  3. Review Payload Formats <\/b>– Review Payload formats to verify the integration.<\/li>\n<\/ol>\n

    To access the Bot Platform\u2019s public APIs, the application making the API request requires authentication. Kore.ai uses the JWT (JSON Web Token) technology to handle the authentication. For a quick overview of the JWT token, refer to Introduction to JWT tokens<\/a>.<\/p>\n

    Configure Webhook as a Channel<\/span><\/h2>\n

    To configure webhook as a channel, follow the below steps:<\/p>\n

      \n
    1. In the Bots<\/b> section of the Bot Builder, click the bot to which you want to add the Webhook channel.<\/li>\n
    2. On the Channels<\/b> tab, click the Webhook<\/b> icon. The Webhook<\/b> page is displayed.
      \"\"<\/a><\/li>\n
    3. Go to the Configurations<\/b> tab of this page and associate this channel with an app.<\/li>\n
    4. Enter a Name<\/strong> for the channel.<\/li>\n
    5. You can select any of the existing Apps<\/strong> available in your Kore.ai account or create a new app.<\/li>\n
    6. Enter a name for the app and click Create<\/strong>. The app is created and Client ID<\/strong> and Client Secret<\/strong> are generated. Copy the Client ID <\/em>and Client Secret<\/em> details.<\/li>\n
    7. If you want to use JSON Web Encryption (JWE) standard, you can view the Public Key<\/em> by clicking the link provided below the Client Secret<\/em> field.<\/li>\n
    8. Webhook channel supports both synchronous<\/strong> and asynchronous<\/strong> modes. Depending on your business needs, you can enable one of these modes in the Configurations<\/strong> tab.\n