Kore.aiは、多くのビルトインボットを提供しています。これを使用して、Kore.aiアカウントのアラートメッセージの表示、ボットタスクの実行、アラートに対する関連タスクの作成などを行うことができます。各アラートは、エンドユーザーが必要とする関連データのみを表示するように、フィルターを定義することができます。このトピックでは、Kore.ai Webhookボットを使用する一般的な手順を説明します。他のボットの詳細情報については、ボットの追加をご覧ください。

Kore.ai Webhookボットは、現在ビルトインボットとして提供されていないWebサイト、システム、Webアプリケーションに対して、Webhookを設定するために使用できる汎用的なWebhookです。

Kore.ai Webhookの設定

Kore.ai Webhookボットを設定するには、管理者権限を持つアカウント、およびWebhookを設定するためのAPIアクセス権が、対応するWebサイト、システム、Webアプリケーションにおいて必要となります。そうでない場合は、システム管理者に連絡する必要があります。Myボット用にWebhookの設定を始めるには、以下、2つのものが必要となります。

  1. カスタムボットで有効にしたいアラートごとに、Kore.aiアカウントでアラートをセットアップした際に提供されたKore.ai webhook URL。
  2. APIにアクセスするための、対応するWebサイト、システム、またはWebアプリケーションのアカウントの有効なユーザー名とパスワード。

WebhookのURLはアカウント固有のもので、他のアカウントに転送することはできません。つまり、テストアカウントを使用してカスタムボットにWebhookを設定した場合、アラートを再作成し、Myボットに設定するための新しいWebhook URLを手に入れる必要があります。以下のURLは、Webhook URLの一例です。 https://app.kore.com/hooks/c6089802f36250c179dcb1aa29afd24c

Kore.ai Webhookボットの設定

この手順では、Kore.ai Webhook URLエンドポイントを用いて、カスタムボットのWebhookを設定する一般的なステップを説明します。

  1. Webhookを追加したいアプリケーションにログオンし、アプリケーションに応じて、 設定、リポジトリのプロパティ、システム連携、アドオンのいずれかを選択します。
  2. Webhookを選択して、URLフィールド、またはコールバックURLフィールドに、アラート用のKore.ai Webhook URLを入力する必要があるかもしれません。
  3. 一部のアプリケーションでは、アプリケーション内のどのイベントがKore.aiのアラートメッセージを開始するかを定義したり、リストから選択したりすることができます。
  4. 場合によっては、イベント発生時にKore.aiに送られるペイロードデータも定義しなければならないか、またはカスタマイズできるかもしれません。
  5. ダイアログを保存して閉じます。

ペイロードの作成

Kore.ai Webhook URLに送信されるペイロードを選択または定義する際には、以下のペイロード要件を遵守する必要があります。

  • HTTPメソッド – POSTに設定
  • ペイロードのコンテンツタイプ – JSONに設定
  • ペイロード – 2つの必要なキー／値ペアを使用した有効なJSON。ペイロードに含まれるその他のキー／値ペアは無視されます。例：
{
    "title": "The title of my alert",
    "description": "The message body of the alert"
}

以下のように、cURLコマンドを使用して、受信したWebhookペイロードを検証することができます。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 カスタムボットにWebhookを設定した後、対応するWebサイト、システム、Webアプリケーションにおいていずれかのイベントが発生すると、Webhookに定義されているKore.aiアカウントのアラートセクションにメッセージが表示されます。

Kore.ai는 Kore.ai 계정에 알림 메시지를 표시하고, 봇 작업을 실행하고, 알림을 위한 관련 작업을 생성하는 데 사용할 수 있는 여러 내장된 봇을 제공합니다. 최종 사용자가 필요로 하는 관련 데이터만 표시하도록 각 알림을 필터로 정의할 수 있습니다. 이 항목에서는 Kore.ai Webhook 봇을 사용하는 일반적인 단계를 설명합니다. 다른 봇에 대한 자세한 내용은 봇 추가하기를 참조하세요.

Kore.ai Webhook 봇은 웹 사이트, 시스템 또는 웹 애플리케이션에 대한 Webhook을 구성하는 데 사용할 수 있는 일반적인 Webhook이며, 현재 내장된 봇으로는 제공되지 않습니다.

Kore.ai Webhook 설정

Kore.ai Webhook 봇을 구성하려면 관리자 액세스 권한이 있는 계정뿐만 아니라 해당 웹 사이트, 시스템 또는 웹 애플리케이션에서 webhook을 구성하는 API 액세스 권한이 있어야 합니다. 액세스 권한이 없다면 시스템 관리자에게 문의해야 합니다. 봇의 Webhook 구성을 시작하려면 다음 두 가지가 필요합니다.

  1. Kore.ai 계정에서 맞춤형 봇에서 활성화할 각 알림을 설정할 때 제공되는 Kore.ai webhook URL입니다.
  2. API 액세스를 위한 해당 웹 사이트, 시스템 또는 웹 애플리케이션의 유효한 사용자 이름 및 암호.

Webhook URL은 계정에 따라 다르며 다른 계정으로 이전할 수 없습니다. 즉, 테스트 계정을 사용하여 맞춤형 봇에 대한 Webhook을 구성하는 경우 알림을 다시 생성하고 봇에서 구성할 새 Webhook URL을 얻어야 합니다. 다음 URL은 Webhook URL의 예시입니다. https://app.kore.com/hooks/c6089802f36250c179dcb1aa29afd24c

Kore.ai Webhook 봇 설정하기

이 절차에서는 Kore.ai Webhook URL 엔드포인트를 사용하여 맞춤형 봇에 대한 Webhook을 설정하는 일반적인 단계를 설명합니다.

  1. Webhook을 추가하려는 애플리케이션에 로그온하고 사용자의 애플리케이션에 따라 설정, 저장소 속성, 통합 또는 추가 기능을 선택합니다.
  2. Webhook을 선택한 다음 URL 필드 또는 콜백 URL 필드에 알림에 대한 Kore.ai Webhook URL을 입력해야 할 수 있습니다.
  3. 일부 애플리케이션을 사용하면 애플리케이션에서 Kore.ai 알림 메시지를 시작할 이벤트를 정의하거나 목록에서 선택할 수 있습니다.
  4. 경우에 따라 이벤트가 발생할 때 Kore.ai로 전송된 페이로드 데이터를 정의하거나 사용자 정의할 수도 있습니다.
  5. 대화 상자를 저장하고 닫습니다.

페이로드 생성하기

Kore.ai Webhook URL로 전송되는 페이로드를 선택하거나 정의할 때 다음 페이로드 요구 사항을 준수해야 합니다.

  • HTTP 메소드 – POST로 설정
  • 페이로드 콘텐츠 유형 – JSON로 설정
  • 페이로드 – 두 개의 필수 키/값 쌍을 사용하는 유효한 JSON. 페이로드에 포함된 다른 모든 키/값 쌍은 무시됩니다. 예:
{ "title": "The title of my alert", "description": "The message body of the alert" }

다음과 같이 cURL 명령을 사용하여 수신 Webhook 페이로드를 검증할 수 있습니다. 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 맞춤형 봇에 대해 Webhook을 구성한 후 해당 웹 사이트, 시스템 또는 웹 애플리케이션에서 이벤트가 발생하면 해당 Webhook에 대해 정의된 Kore.ai 계정에 대한 알림 섹션에 메시지가 표시됩니다.

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.

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.

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 a 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 is 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
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.