この機能はEnterpriseプランをご利用のお客様のみご利用いただけます。有効化をご希望の場合は、担当のCSMまでお問い合わせください。

この記事では、以下の内容について説明します。
リアルタイムアラートをトリガするイベント
リアルタイムアラートWebhookを使用すると、対象のイベントがトリガされたときにリアルタイムで通知を受け取ることができます。これらのイベントはシステム内のどこでも発生する可能性がありますが、現時点では以下の5種類に限定されています。
- エスカレーションが失敗した
- アクションが失敗した
- 汎用的な技術エラーメッセージがチャットで送信された
- カスタムバックエンドインテグレーションが失敗した。このイベントでは、該当するバックエンドインテグレーションが
dataオブジェクト内に指定されます。 - テスト - AIエージェントワークスペースからテストイベントをトリガできるため、開発者は他のいずれかのトリガを待たずに、Webhookの使用方法をテストして実装できます。
いずれかのイベントがトリガされると、以下のパラメータを含むリクエストがWebhook URLに送信されます。
| 名前 | タイプ | 説明 |
| botName | 文字列 | イベントをトリガしたAIエージェントの名前 |
| event | 文字列 | 5種類のイベントタイプ |
| conversationId | 文字列 | 一意の会話ID |
| platformConversationId | 文字列 | プラットフォーム固有の会話ID |
| data | オブジェクト | メタデータ。主にバックエンドインテグレーションイベントで使用されます。 |
カスタムバックエンドインテグレーションイベントでは、データオブジェクトに以下のパラメータが追加されます。
| 名前 | タイプ | 説明 |
| botId | 文字列 | 各AIエージェントに固有の24桁の英数字の組み合わせ。詳しくはこちらを参照 |
| conversationId | 文字列 | 一意の会話ID |
| conversationLink | 文字列 | 会話ログ内の該当する会話へのリンク |
| httpStatus | 数値 | エラーのステータスタイプ |
| endpointUrl | 文字列 | バックエンドインテグレーションの送信先URL |
Webhookの設定
Webhookの設定には、AIエージェントの設定 > 全般 > Webhookからアクセスできます。この設定はEnterpriseのお客様にのみ表示されます。
設定するには、以下の手順に従います。
- AIエージェントワークスペースで、「AIエージェント設定」>「全般」>「Webhook」に移動します。
- データツールからWebhook URLをコピーし、指定のフィールドに貼り付けます。https URLのみ使用できる点にご注意ください。
- 「トークンを表示」をクリックし、認証トークンを使用して、データツールでアラートメッセージを取得できるようにします。
- 「Webhookを使用してAIエージェントのパフォーマンスを追跡する」をクリックして、機能をアクティブにします。
- 更新したAIエージェントの設定を「保存」します。これで「Webhookをテスト」ボタンが有効になります。
- 「Webhookをテスト」をクリックして、Webhook URLとして指定したURLにテストイベントを送信します。最後の手順は任意ですが、実行することをお勧めします。