1. Home
  2. Kore.ai Conversational Platform
  3. Advanced Topics
  4. Bot Store
  5. Adding Bots
  6. Adding a Webhook Bot

Adding a Webhook Bot

Kore.ai provides integration for a built-in Kore.ai Webhooks Bot that you can use to display message notifications and execute tasks directly from the Kore.ai application. To use the Kore.ai Webhooks Bot, you just need to add the Bot to your Kore.ai account, and then configure the settings for the Bot, such as authentication to access Kore.ai Webhooks, and the notification messages that you want. This topic describes the Kore.ai Webhooks built-in Bot for Kore.ai. For more information about other Kore.ai Bots, see Adding Bots.

About the Webhook Bot

DIYKore.aiCustomWebhookLogoThe Kore.ai Webhook bot is a generic bot that you can use to configure webhooks for a website, system, or web application, not currently offered as a built-in Bot.

Integration Type Webhook – Connect to this Bot using a webhook integration where the web application pushes message notifications in near real time.
Category Developer Tools – This Bot is available in the Kore.ai application in the Developer Tools category.

Configuring a Kore.ai Webhook

To configure a Kore.ai Webhooks, you must have an account with administrator access as well as API access to configure a webhook, in the corresponding website, system, or web application. If you don’t, you’ll need to contact the system administrator.

To get started configuring the webhook for your Bot, you’ll need two things:

  1. The Kore.ai webhook URL provided when you set up an alert in your Kore.ai account for each alert that you want to enable in custom Bot.
  2. A valid Username and Password for the corresponding website, system, or web application account for API access.

The webhook URL is account-specific and cannot be transferred to any other account. This means that if you configure webhook for your custom Bot using a test account, you will have to recreate the alert and get a new webhook URL to configure in your Bot. The following URL is an example webhook URL.


Configuring Webhook

This procedure describes the generic steps to configure a webhook for a custom Bot using a Kore.ai webhook URL endpoint.

  1. Log on to your application that you want to add a webhook to, and depending on your application, select Settings, Repository properties, Integrations, or Add Ons.
  2. You may have to select Webhook, and then in the URL field, or Callback URL field, enter the Kore.ai webhook URL for the alert.
  3. Some applications allow you to define or select from a list which events in the application will initiate a Kore.ai alert message.
  4. In some cases, you must also define, or you may be able to customize the payload data sent to Kore.ai when the event occurs.
  5. Save and close the dialog.

Creating the Payload

When you select or define the payload sent to the Kore.ai webhook URL, you must adhere to the following payload requirements:

  • HTTP method – Set to POST
  • Payload Content Type – Set to JSON
  • Payload – Valid JSON using two required key/value pairs. Any other key/value pair included in the payload are ignored. For example:

   “title”: “The title of my alert”,
   “description”: “The message body of the alert”

Validating Your Webhook

You can validate your incoming webhook payload using cURL commands as follows:

curl -X POST -H “Content-Type: application/json” -d ‘{“title”:”alert title goes here”,”description”:”alert body content goes here”}’ https://app.kore.com/hooks/c6089802f36250c179dcb1aa29afd24c

After you are connected, you can perform tasks for Kore.ai Webhooks directly from the Kore.ai application and setup message notifications to get notified in the Kore.ai application when an event occurs in Kore.ai Webhooks.

You can integrate a Kore.ai Webhooks task with Kore.ai. To configure the Outgoing Webhook task, click , click Outgoing Webhook, and then in the Perform Task dialog:

  • enter a URL
  • enter a Title
  • and then, enter a Description.

In a space room, you can enter the @webhook outgoingwebhook Bot command to invoke and configure this task.

You can setup message notifications to your Kore.ai account using a Kore.ai Webhooks. Click , click Get notified when…, click Incoming Webhook, and then in the Setup Task dialog:

  • click the Activate button to generate a Webhook URL.
  • copy and save the URL, or click Email Instructions to send the URL to an email account. For more information, see Configuring Kore.ai Webhooks.
  • optionally customize the Task Name 
  • optionally customize the Short Description
  • enable or disable Mute task notifications.

Next Steps

After the webhook is configured for your custom Bot, when any of the events occur in the corresponding website, system, or web application, a message is displayed in the Alerts section for the Kore.ai account defined for the webhook.

Was this article helpful to you? Yes No 2