プレメッセージとポストメッセージのウェブフックにおける認証方法の定義
このドキュメントでは、AIアシスタントにおけるメッセージ送信前およびメッセージ送信後のWebhookの認証設定手順について説明します。 利用可能な認証方法とその設定方法について説明する。
概要
Webhookを使用すると、外部システムが AIアシスタントと通信できるようになります。 認証は、許可されたソースのみがウェブフックをトリガーできることを保証する。 このドキュメントでは、Webhook 認証の設定と管理の手順について説明します。
開始前に
ウェブフック認証を設定する前に
Builder、またはAdmin。トークン・リクエストURL(必要な場合)、パスワードやトークンなどのシークレットを含む、ターゲット・サーバーの認証詳細が必要です。
手順
ホーム > 環境へ。
「下書き 」タブ > 「下書き環境 」または 「公開 」タブ > 「公開環境 」のいずれかから
、「設定」 を選択してください。定義したい内容に応じて、 Pre-message webhook または Post-message webhookのいずれかを選択します。
Webhook setupまでスクロールし、API URL を貼り付ける。
認証の編集] をクリックして、 [認証の設定] ページを開きます。
ドロップダウンで、以下のオプションのいずれかを選択します:
保存 をクリックします。
認証なし
これはデフォルト・オプションです。
ベーシック認証
ユーザー名とパスワードを入力してください。
ベアラ認証
ベアラートークンを入力します。
APIキー認証
APIキー名と APIキーを入力します。
署名入りJWT
シークレットに入る
「パスワードを表示」 アイコンをクリックして、
秘密のコードを確認してください。
OAuth 2.0
Scope文字列を使用する場合は、ターゲット・サーバで定義されている1つ以上の認証スコープを、スペースで区切って指定する必要がある。 例えば、write、read+write、email-readなど。
Grant type(補助金の種類 )で、以下のオプションのいずれかを選択する:
保存 をクリックします。
パスワード
ウェブフックのユーザー名を入力してください。
Webhookサービスのパスワードを入力します。
Webhook認証サービスのクライアントIDを入力します。
Webhookを認証するためのクライアントシークレットを入力します。
トークン URL を入力します。
Refresh トークン URL を入力してください。
オプション: サービスにスコープ文字列が必要な場合は、ターゲットサーバーで定義されているスコープ文字列を入力します。
クライアント認証では、以下のいずれかのオプションを選択する必要があります:
Basic Authヘッダーとして送信する: 認証情報は HTTP ヘッダーで送られる。
本文として送信: 認証クレデンシャルはリクエストボディに送信されます。
ヘッダーのプレフィックスを入力します:ベアラ
クライアント資格情報
Webhook認証サービスのクライアントIDを入力します。
Webhookを認証するためのクライアントシークレットを入力します。
トークン URL を入力します。
Refresh トークン URL を入力してください。
オプション: サービスにスコープ文字列が必要な場合は、ターゲットサーバーで定義されているスコープ文字列を入力します。
クライアント認証では、以下のいずれかのオプションを選択する必要があります:
Basic Authヘッダーとして送信する: 認証情報は HTTP ヘッダーで送られる。
本文として送信: 認証クレデンシャルはリクエストボディに送信されます。
ヘッダーのプレフィックスを入力します:ベアラ
認証コード
Webhook認証サービスのクライアントIDを入力します。
認証サーバー URL を入力する。
トークン URL を入力します。
Refresh トークン URL を入力してください。
オプション: サービスにスコープ文字列が必要な場合は、ターゲットサーバーで定義されているスコープ文字列を入力します。
クライアント認証では、以下のいずれかのオプションを選択する必要があります:
Basic Authヘッダーとして送信する: 認証情報は HTTP ヘッダーで送られる。
本文として送信: 認証クレデンシャルはリクエストボディに送信されます。
ヘッダーのプレフィックスを入力します:ベアラ
オプション: ターゲットサーバーに応じて、リダイレクトURLを OAuth アプリの「コールバック URL 」フィールドにコピーしてください。
アクセスを許可 」をクリックします。
付与サーバーが提示するページのステップを完了します。
アシスタントにリダイレクトされ、編集モーダルが再度開きます。
クライアントIDの下にクライアントシークレットを入力します。
カスタム
Webhookのカスタムグラントタイプ名を入力します。
トークン URL を入力します。
Refresh トークン URL を入力してください。
オプション: サービスにスコープ文字列が必要な場合は、ターゲットサーバーで定義されているスコープ文字列を入力します。
クライアント認証では、以下のいずれかのオプションを選択する必要があります:
Basic Authヘッダーとして送信する: 認証情報は HTTP ヘッダーで送られる。
本文として送信: 認証クレデンシャルはリクエストボディに送信されます。
ヘッダーのプレフィックスを入力します:ベアラ
アプリケーションにカスタムシークレットを追加する必要がある場合は、以下の手順に従ってください:
秘密の追加をクリックする。
シークレット名と シークレット値を入力します。
オプション: さらに秘密名と秘密値を追加したい場合は、「 Add secret +」をクリックします。
Add parameter + をクリックする。
パラメータ名と パラメータ値を入力する。
オプション: さらにパラメータ名とパラメータ値を追加したい場合は、 Add parameter +をクリックします。