WebhookブロックのGETメソッド
顧客への対応を行うにあたって、他のアプリ／システムに登録されている顧客の注文ステータス、予約の詳細、商品の在庫状況などの情報を確認したい場合があります。
WebhookブロックのGETメソッドでは、Zoho Desk、Zoho CRM、注文システム、ナレッジベースなどの外部アプリ／システムからデータをリアルタイムで取得できます。取得した情報は、自動ガイドボットのチャットのメッセージ内に表示することが可能です。チャットの対応業務をよりスムーズに行うことができます。
以下では、WebhookブロックのGETメソッドの概要やよくある質問について説明します。
GETメソッドとは
GETメソッドとは、APIを通じて別のアプリ／システムからデータを取得する仕組みです。
例：
特定の顧客に関するデータを取得したいとします。
この場合、GETメソッドを使用することで、該当の顧客のデータを取得してチャット内で表示できます。この処理は自動で行われます。データを直接操作する必要はありません。
GETメソッドの主な使用例
GETメソッドの主な使用例は、以下のとおりです。
- 参照番号をもとに顧客の注文を確認する
- ユーザーIDまたはメールアドレスをもとに予約状況を確認する
- Zoho Deskの過去の問い合わせを表示する
- 商品の詳細や在庫状況を取得する
- ナレッジベースの関連記事を取得する
使用するタイミング
GETメソッドが役に立つタイミングは、以下のとおりです。
- Zoho DeskやZoho CRMに保存されているユーザーの詳細を確認したい
- 注文管理システムに登録されている最新の注文ステータスを表示したい
- 予約情報や旅程を取得したい
- 外部データベースのヘルプドキュメントや製品データを参照したい
チャットでの対応時において最新情報を取得し、チャットの利用者とのやりとりにおいて使用することで、対応をよりスムーズに進めることができます。
使用例
使用例
顧客が注文のステータスを確認したいとします。この場合、GETメソッドを使用して注文ステータスのデータを取得し、チャット欄に表示できます。
レスポンスのサンプル
{
"subCategory" : "サブ（一般）",
"statusType" : "未完了",
"subject" : "注文の処理が遅れています。優先的に確認をお願いします。",
"dueDate" : "2025-06-21T16:16:16.000Z",
}
Webhookブロックの各メソッドの違い
GET
POST
PUT
PATCH
DELETE
GET
| 主な使用目的 | 一般的な使用例 | リクエストボディ | 例 |
| サーバーからデータを取得する | ユーザー情報の取得 問い合わせの履歴の取得 ナレッジベースの記事の取得 | × | メールアドレスをもとに顧客のサブスクリプション情報を表示する |
POST
| 主な使用目的 | 一般的な使用例 | リクエストボディ | 例 |
| 外部アプリ／システムに新しいデータを作成する | 新しい問い合わせの作成 フォームの送信 ユーザーのフィードバックの記録 | ○（例：JSON） | チャットの利用者の情報をもとにZoho Deskで新しい問い合わせを作成する |
PUT
| 主な使用目的 | 一般的な使用例 | リクエストボディ | 例 |
| 既存のデータを更新する／置き換える | 問い合わせのステータスの更新 連絡先情報の更新 サブスクリプション情報の変更 | ○（すべてのデータ） | 問い合わせの優先度を「緊急」に変更する |
PATCH
| 主な使用目的 | 一般的な使用例 | リクエストボディ | 例 |
| 既存のデータの一部を更新する | 問い合わせの優先度の更新 顧客の電話番号の変更 特定の項目の更新 | ○（一部のデータ） | 問い合わせのステータスの項目のみを「対応中」に更新する |
DELETE
| 主な使用目的 | 一般的な使用例 | リクエストボディ | 例 |
| サーバーからデータを削除する | 問い合わせの削除 ユーザーの登録解除 顧客のデータの削除 | 任意 | ユーザーの問い合わせを削除する |
GETメソッドのメリット
- データを変更せずに安全に取得できます。
- 外部アプリ／システムに保存されている最新情報を常に表示できます。
- 取得したデータをもとに、ボットの会話フローの分岐を設定できます（例：注文ステータスが「配送済み」の場合、配送情報を表示する）。
よくある質問
GETメソッドによってデータは変更されませんか？
はい、データは変更されません。GETメソッドでは、データの取得のみが行われます。データの変更などの他の処理は行われません。安全に何度でも使用できます。
GETメソッドでは、どの種類のAPIが使用されますか？
Zoho Desk、Zoho CRM、注文システム、データベース、SaaSなどの外部アプリ／システムにおいて、GETメソッドに対応しているREST APIが使用されます。
取得したデータに対してフィルターを適用できますか？
はい、できます。例：?email=user@example.com.
使用に関するヒント
- {{user.email}}、{{user.id}}などの動的変数を使用し、リクエストをカスタマイズできます。
- パラメーターや構造に関する詳細については、APIドキュメントをご参照ください。
- 会話フロー内の値（例：注文ステータス）を保存し、後で使用できます。
- リクエストに失敗する場合、URLとパラメーターをもう一度確認してください。
- PostmanなどのツールでAPIのテストをあらかじめ行うことで、不具合に迅速に対応できます。