WebhookブロックのPOSTメソッド

顧客への対応を行うにあたって、ボットを通じて他のアプリ／システムで問い合わせを作成したり、チャットの利用者から受け取ったフィードバックを保存したり、フォームの回答を記録したりしたい場合があります。このような場合、WebhookブロックのPOSTメソッドが役立ちます。

WebhookブロックのPOSTメソッドでは、APIに対応しているZoho Desk、Zoho CRM、他の外部アプリ／システムに対して、ボットを通じてデータを送信できます。

以下では、WebhookブロックのPOSTメソッドの概要やよくある質問について説明します。

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

POSTメソッドとは

POSTメソッドとは、APIを通じて別のアプリ／システムにデータを送信する仕組みです。

POSTメソッドの主な使用例は、以下のとおりです。

ユーザー名、メールアドレス、説明の内容をもとに新しい問い合わせを作成する
ボットを通じて送信されたフィードバックを組織のデータベースに保存する
チャットを通じて受け取ったデータを、Zoho Desk、CRMシステム、他の分析サービスに送信する

POSTメソッドを使用するタイミング

POSTメソッドが役に立つタイミングは、以下のとおりです。

チャットの利用者から受け取った情報をもとに、新しい問い合わせを作成する
顧客が入力したフォームを、Zoho Deskや組織のデータベースに保存する（例：名前、メールアドレス、選択されたセッションなどのイベントの登録情報を保存する）
チャットの利用者から受け取った情報をもとに、Zoho CRMに見込み客のデータを追加する

ボットによって他のアプリ／システムに送信された情報をもとに、特定の処理を実行することが可能です。

使用例

チャットの利用者から受け取った情報をもとに、Zoho Deskで新しい問い合わせを作成したいとします。

例：新しい問い合わせの作成

設定：

POST URL： https://desk.zoho.com/api/v1/tickets

リクエストボディの例（JSON形式）：

{

"contact": {

"lastName": "{{user.name}}",

"email": "{{user.email}}"

"subject": "ユーザーによって報告された不具合",

"description": "{{user.query}}",

"priority": "高",

"departmentId": "1234567890000001"

}

上記のJSONの解説

名前、メールアドレス、不具合の内容は、動的変数を通じてチャット時のメッセージから取得されます。

標準の優先度は「高」に設定されています。

APIのレスポンスの例

{

"ticketNumber" : "773",

"subCategory" : "サブ（一般）",

"statusType" : "未完了",

"subject" : "すぐに確認をお願いします",

"departmentId" : "1892000000006907",

}

このレスポンスを使用して問い合わせの作成を確定し、以下のメッセージを表示できます。

「{{user.name}}様へのお知らせ：問い合わせ（番号：TX12345）が作成されました。担当者よりご連絡いたします」

POSTメソッドのボディの概要

ボディとは、外部アプリ／システムに送信するデータを指定するためのものです。ほとんどのAPIにおいてボディはJSON形式にする必要があります。なお、フォームデータに対応しているAPIもあります。

ボディに含まれている主な情報は、以下のとおりです。

名前
メールアドレス
メッセージ（または不具合の内容）
優先度、カテゴリー
APIに対応するカスタム項目

ボディに関して行える内容は、以下のとおりです。

WebhookブロックにJSONを手動で入力できます
必要に応じてJSONファイルをアップロードできます（詳細については、あなたの組織のシステム担当者にお問い合わせください）
{{user.name}}、{{user.query}}などの動的変数を使用して、チャットのメッセージ内に挿入できます

フォームデータ

特定のサービスや長く使用されているAPIなどの一部のAPIでは、JSONではなくフォームデータが必要です。この場合、以下のようにキーと値のペアを入力します。

name = {{user.name}}

email = {{user.email}}

message = {{user.query}}

APIの対応形式（JSONまたはフォームデータ）や必須項目に関する詳細については、APIのドキュメントをご参照ください。

Webhookブロックの各メソッドの違い

GET

POST

PUT

PATCH

DELETE

GET

主な使用目的	一般的な使用例	リクエストボディ	例
サーバーからデータを取得する	ユーザー情報の取得問い合わせの履歴の取得ナレッジベースの記事の取得	×	メールアドレスをもとに顧客のサブスクリプション情報を表示する

POST

主な使用目的	一般的な使用例	リクエストボディ	例
外部アプリ／システムに新しいデータを作成する	新しい問い合わせの作成フォームの送信ユーザーのフィードバックの記録	○（例：JSON）	チャットの利用者の情報をもとにZoho Deskで新しい問い合わせを作成する

PUT

主な使用目的	一般的な使用例	リクエストボディ	例
既存のデータを更新する／置き換える	問い合わせのステータスの更新連絡先情報の更新サブスクリプション情報の変更	○（すべてのデータ）	問い合わせの優先度を「緊急」に変更する

PATCH

主な使用目的	一般的な使用例	リクエストボディ	例
既存のデータの一部を更新する	問い合わせの優先度の更新顧客の電話番号の変更特定の項目の更新	○（一部のデータ）	問い合わせのステータスの項目のみを「対応中」に更新する

DELETE

主な使用目的	一般的な使用例	リクエストボディ	例
サーバーからデータを削除する	問い合わせの削除ユーザーの登録解除顧客のデータの削除	任意	ユーザーの問い合わせを削除する