WebhookブロックのURLの項目

WebhookブロックのURLの項目


WebhookブロックのURLの項目では、Webhookを通じてデータの送受信を行う場所(エンドポイント)を指定します。
具体的には、接続先の外部アプリ/システムのREST APIエンドポイントのURLを入力します。この情報は、Webhookブロックを利用して、データの送信/取得/更新/削除などの処理を実行するために必要です。以下では、WebhookブロックのURLの項目の概要や使用例について説明します。  


参考情報:自動ガイドボットのWebhookブロックの概要 

URLの入力

URLは、正しく入力するようにしてください。URLが正しくない場合、Webhookを通じたデータ通信が適切に行われなくなります。対象のサービスのAPIドキュメントを確認のうえ、以下の内容にご注意ください。
  1. エンドポイントURLが正しく入力されている
  2. 「https://」 からはじまる、セキュア接続で保護されているドメインが使用されている
  3. 会話フロー内において、パラメーター(例:/customer/{id})に対して値が適切に挿入されている
 
URL内への変数の挿入

URL内に変数を挿入できます。たとえば、URL内に@user.input、@org.idといった変数を使用することで、チャットの利用者によって入力された利用者IDや組織IDをURLに挿入することが可能です。これにより、チャットの利用者に応じた処理を実行できます。
 

使用例
使用例
請求システムから顧客のサブスクリプション情報を取得したいとします。この場合、以下のようにURLを指定することで、APIを通じて情報を取得することが可能です。


URLの解説
  1. https://api.billingplatform.com」は、外部の請求システムのドメインを表します
  2. 「/v1/subscriptions」は、アクセス先を表します
  3. 「?Email=jane@example.com」は、クエリーパラメーターを表します。対象となる顧客のメールアドレスが指定されます
 URLの項目を設定するにあたって、該当のURLへのアクセスが許可されているかどうかをご確認ください。