1. Home
  2. Kore.ai Conversational Platform
  3. Bot Store
  4. Setting Up the Kore.ai Webhook Bot

Setting Up the Kore.ai Webhook Bot

Kore.ai provides many built-in Bots that you can use to show alert messages in a Kore.ai account, execute Bot tasks, and create a related task for an alert. Each alert can be defined with filters to display only the relevant data needed by the end-user.

This topic describes the generic steps using the Kore.ai Webhook Bot. For more information about other Bots, see Adding Bots.

About the 

The Kore.ai Webhook Bot is a generic webhook 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

Configuring Kore.ai Webhooks

To configure the Kore.ai Webhook Bot, 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 you 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.

https://app.kore.com/hooks/c6089802f36250c179dcb1aa29afd24c

Configuring the Kore.ai Webhook Bot

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"
}

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

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