Webhookの設定と利用方法

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

Webhook は、リモートセッションや画面共有セッションの開始など、特定のイベントが発生したときに、設定した URL へ通知を送信できる高度な連携機能です。1 つのコールバック URL で複数のイベントを受信できます。Webhook 機能はZoho Assist エンタープライズ版でのみ利用できます。

Webhook の作成

手順 1: Zoho Assist にログインします。

手順 2: ［設定］>［Integrations］>［Webhook］に移動します。

手順 3: ［Webhook を追加］を選択します。

手順 4: 名前、説明、Callback URL を入力します。

イベントが発生すると、データ元 ID が作成されます。データ元 ID はカスタマイズ可能な ID で、同じイベントに対して通知がループ送信されるのを防ぐために Webhook に付与されます。

手順 5: ［Ping URL］をクリックして、コールバック URL をテストします。

手順 6: ［イベントを選択］の下に表示されるドロップダウンから、タブ、イベント名、部署を選択します。

Webhook のイベントは、それぞれ対応するイベント ID に紐づいており、次のとおりです。

Webhook 処理	処理 ID
アウトバウンドセッション開始	0
セッション開始 - 画面共有	1
セッション終了 - リモートサポート	2
セッション終了 - 画面共有	3
顧客参加 - リモートサポート	4
インバウンドリクエスト作成	5
インバウンドリクエスト転送	6
インバウンドリクエスト委任	7
インバウンドリクエスト選択済み	8
インバウンドリクエスト却下済み	9
インバウンドリクエスト切断	10
インバウンドリクエスト期限切れ	11
デバイス追加	12
デバイスオンライン	13
デバイスオフライン	14
デバイス削除	15
セッション開始	16
セッション終了	17

手順 7: 「Ping Event」をクリックして、選択したイベントをテストし、テスト実行をトリガーします。

手順 8: [Webhook を作成] をクリックします。

作成した Webhook は、Webhook メニューからいつでもアクセスして編集できます。

メモ:

Webhook は合計 20 個まで作成でき、各イベントに対して最大 10 個まで設定できます。
Webhook を機能させるには、サードパーティとの連携が必要です。

API 連携 :

OAuth スコープ:

ZohoAssist.Webhook.READ
ZohoAssist.Webhook.CREATE
ZohoAssist.Webhook.UPDATE
ZohoAssist.Webhook.DELETE
ZohoAssist.Webhook.ALL

属性名	データ型	説明
name	string	Webhook の名前。
desc(Optional)	string	Webhook の説明。
url	string - 有効な https URL	処理情報を送信するサーバーのエンドポイント。
ignore_src(Optional)	string	Webhook をトリガーする際に除外するクライアント ID。
subscriptions	array of subscriptions	購読させたい処理（イベント）の一覧。
status	0(無効) または 1(有効)	Webhook のステータス。
hook_id	long	インスタンス内のフック項目の主キー (pk)。
event_id	integer	イベントの ID。
dept_ids	long[]	複数の部署 ID。