現在のプランを確認
アドオン AIエージェント - Advanced

この機能はEnterpriseクライアントでのみ使用できます。有効にする場合は、CSMにお問い合わせください。

Real_time_webhook_example.png

この記事では、次のトピックについて説明します。

  • リアルタイムアラートをトリガするイベント
  • Webhook設定

リアルタイムアラートをトリガするイベント

リアルタイムアラートWebhookを使用すると、対象のイベントがトリガされるとリアルタイムで通知を受けることができます。これらのイベントは、システム内のどこでも発生する可能性がありますが、現時点では、以下の5つに制限されています。 

  1. エスカレーション失敗

  2. アクション失敗

  3. 一般的な技術的エラーメッセージがチャットで送信された

  4. カスタムバックエンドインテグレーション失敗 - このイベントでは、正確なバックエンドインテグレーションがdataオブジェクトに指定されています。

  5. テスト - AIエージェント（Advanced）ダッシュボードからテストイベントをトリガできるため、開発者はトリガのいずれかを待つことなく、Webhookをテストして実装できます。

イベントの1つがトリガされると、すぐに次のパラメータを含むリクエストがWebhook URLに送信されます。

名前 タイプ 説明
botName 文字列 イベントをトリガしたAIエージェントの名前
イベント 文字列 5つの異なるイベントタイプ
conversationId 文字列 一意の会話ID
platformConversationId 文字列 プラットフォーム固有の会話ID
data オブジェクト Metadata（ほぼインテグレーションイベントで使用）

カスタムバックエンドインテグレーションイベントでは、次のパラメータを使用してdataオブジェクトを強化します。

名前 タイプ 説明
botId 文字列 各AIエージェント固有の24桁の数字と文字の組み合わせ。高度な機能を検討します。
conversationId 文字列 一意の会話ID
conversationLink 文字列 会話ログ内の指定された会話へのリンク
httpStatus 数値 エラーステータスのタイプ
endpointUrl 文字列 バックエンドインテグレーションをターゲットとするURL

Webhook設定

Webhook設定には、AIエージェント設定 > 一般 > Webhookからアクセスできます。これはエンタープライズカスタマーにのみ表示されます。

設定するには、以下の手順に従ってください。

  1. AIエージェント（Advanced）ダッシュボードで、AIエージェント設定 > 一般 > Webhookに移動します。

  2. データツールからWebhook URLをコピーして、定義されたフィールドに貼り付けます。https URLのみ使用できる点に注意してください。

  3. トークンを表示をクリックし、認証トークンを使用してデータツールでアラートメッセージを取得します。

  4. Webhookを使用してAIエージェントのパフォーマンスを追跡をクリックして機能を有効にします。

  5. 更新したAIエージェントの設定を保存します。Webhookテストボタンが有効になりました。

  6. Webhookテストボタンをクリックして、Webhook URLとして指定したURLにテストイベントを送信します。最後の手順は任意ですが、お勧めします。 

Powered by Zendesk