Webhookの設定

Webhookは、アプリから他のアプリへメッセージやデータを送信する方法の1つです。たとえば、Zoho Deskで問い合わせが更新された時に、Webhookの機能によって外部のサービスにZoho Deskから関連データを送信することができます。設定は簡単です。通知先のURLを登録するだけで、Webhookを設定できます。

以下は、Webhookの活用が適している例です。

問い合わせの完了後、対応工数に関する情報を会計ソフトウェアに送信して、会計ソフトウェアで請求書を作成する。
メールマーケティングソフトウェアのメール配信リストに登録希望者を追加して、あとで販促メールを配信する。
現場でのサービス提供を行う担当者に対して、顧客情報、予約日時、訪問先の場所などの関連情報のメッセージを送信する。（アプリで会計を行った際に、アプリからテキストメッセージやメールが送信されるのと同様です）

機能の利用可否と上限

必要な権限
この機能を利用するには、システム管理者のWebhookの権限が必要です。
各プランの機能と制限を確認する

機能の利用可否と上限

Zoho DeskのWebhook機能に関する利用可否と上限は、以下のとおりです：

プラン	利用可否	上限
無料	×	--
スタンダード	×	--
プロフェッショナル	○	5件
エンタープライズ	○	10件

メモ：

ソースIDはUUID形式で入力する必要があります。
Webhookの設定は、組織単位で適用されます。設定できるWebhookの上限は、有効な設定と無効な設定の両方を含めて20件です。
一般に公開されていてアクセス可能であり、認証が不要なWebhookにのみ対応しています。また、Webhookのペイロードにおいて通知先のURLを指定することはできません。
拡張機能を通じて作成されたWebhookをZoho Desk内で編集したり、無効にしたりすることはできません。これらの操作は、該当の拡張機能の画面で行う必要があります。
Webhookに関する詳細については、こちらをご参照ください。

Webhookに対応しているタブと操作

Zoho Deskのタブには一連の情報が表示されます。タブで行われる操作に関して、外部のサービスに対して関連データを自動送信するように設定することができます。Webhookに対応しているタブと、Webhookの実行タイミングとして設定可能な処理は、以下のとおりです：

タブ	設定可能な処理
問い合わせ	追加
	更新（前回の値あり）
	更新（前回の値なし）
	削除
	メッセージの受信
	メッセージの送信
	すべてのやりとり
	コメントの追加
	コメントの更新
	添付ファイルの追加
	添付ファイルの更新

連絡先	追加
	更新（前回の値あり）
	更新（前回の値なし）
	削除

取引先	追加
	更新（前回の値あり）
	更新（前回の値なし）
	削除

部門	追加
	更新（前回の値あり）
	更新（前回の値なし）

担当者	追加
	更新（前回の値あり）
	更新（前回の値なし）
	削除

タスク	追加
	更新（前回の値あり）
	更新（前回の値なし）

工数	追加
	更新（前回の値あり）
	更新（前回の値なし）
	削除

［問い合わせ］タブでの［特定の項目の更新（前回の値あり）］の処理と、［特定の項目の更新（前回の値なし）］の処理の設定では、5件まで項目を選択できます。

Webhookの作成

上記のタブとタブで行われる操作に対して、Webhookを作成できます。

Webhookを作成するには：

上部のバーの設定アイコン（）をクリックし、［開発者向け情報］内にある［Webhook］をクリックします。
Webhookの一覧画面で、［最初のWebhookの追加］、または［新しいWebhook］をクリックします。
新しいWebhookの画面で、以下の手順を実施します：

［名前］の項目にWebhookの名前を入力します。
［通知先のURL］の項目に、外部のサービスのURL（REST APIのURLなど）を入力します。
Webhookの説明を追加します。
Zoho DeskでAPI関連処理が実行される際に、通知を受け取るサービスで使用されるソースIDを指定します（詳細はこちら）。
メモ：ソースIDはUUID形式で入力する必要があります。
イベントの選択の項目で、タブ、イベント、部門といった詳細情報を選択します。
（+）アイコンをクリックすると、複数のイベントを追加できます。

［テスト実行］をクリックして、サンプルのペイロードを送信して入力したURLが有効かどうかを確認します。
［保存する］をクリックします。

Zoho Deskでは、選択されたイベントが行われるたびに、指定したURLに向けてHTTP POSTによりデータが送信されます。
タブのイベントの列をクリックすると、指定したWebhookのイベントの件数が表示されます。イベントをクリックするとポップアップ画面が表示されます。こちらから、Webhookの処理の実行のきっかけとなる、すべてのイベントに関する概要を確認できます。

Webhookにカーソルを合わせると、操作メニューのアイコンが表示されます。こちらからWebhookのテストを行ったり、Webhookを編集／削除したりできます。Webhookを無効にするには、切り替えボタンをクリックします。無効にした後、必要に応じて再度有効にすることも可能です。

Webhookへのフィルターの適用

Webhookにフィルターを適用し、特定のWebhookのみを抽出して一覧に表示できます。

フィルターを適用するにあたって使用できる条件は、以下のとおりです。

タブ：タブを選択します。該当のタブのWebhookが表示されます。
イベント：Webhookの実行条件として設定されているイベントを選択します。例：追加、削除、更新、コメントの追加、セッションのステータス変更など
ステータス：Webhookのステータスを選択します。
すべて選択：有効なWebhookと無効なWebhookの両方のWebhookを表示します。
有効：有効なWebhookのみ表示します。
無効：無効なWebhookをすべて表示します。

重要：

名前、通知先のURL、説明の項目に特殊文字を使用することはできません。
Webhookを使用して、外部のサービスのアプリからZoho Deskでデータを受け取ることはできません。