ウェブフック

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

Webhook は、特定の処理（リモートセッションの開始や画面共有セッションなど）が発生した際に、通知を設定済みのURLへ送信することができる詳細なインテグレーションです。単一のコールバックURLを通じて、任意の数の処理を受信できます。Webhook 機能はZoho Assist エンタープライズエディションのみでサポートされています。

Webhook の作成

手順 1 : Zoho Assist にログインする

手順 2 : 設定 > Integrations > Webhook に移動する

手順 3 : 「Webhook を追加」を選択する

手順 4 : 名前、説明、Callback URL を追加する

イベントが実行されると、データ元IDが作成されます。データ元IDはWebhookでカスタマイズ可能なIDであり、同一イベントに対する通知のループを防ぐために利用されます。

手順 5 : 「Ping URL」をクリックし、コールバックURLをテストします

手順 6 : 下記のドロップダウンからタブ、Event名、部署差出人を選択します Eventを選択

Webhook処理は各イベントIDに対応しており、下記の通りです。

Webhook処理	処理ID
Outbound Session開始	+10、-10
セッション開始 - Screen 共有	1
セッション終了 - Remote サポート	2
セッション終了 - Screen 共有	3
顧客参加 - Remote サポート	4
Inbound Request 作成	5
Inbound Request 転送	6
Inbound Request 委任	7
Inbound Request 選択済み	8
Inbound Request 却下済み	9
Inbound Request ドロップ済み	10
Inbound Request 期限切れ	11
Device 追加	12
Device オンライン	13
Device オフライン	14
Device 削除	15
Session 開始する	16
Session 終了	17

手順 7 : 「Ping Event」をクリックして、選択したイベントが正しくトリガーされるかテストします。

手順 8 : 「作成 Webhook」をクリックします。

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

メモ:

Webhookは合計20個まで作成でき、各イベントにつき最大10個まで設定可能です。
Webhookの利用には、サードパーティとの連携が必要です。

API連携 :

OAuthスコープ:

ZohoAssist.Webhook.READ
ZohoAssist.Webhook.作成
ZohoAssist.Webhook.更新する
ZohoAssist.Webhook.削除
ZohoAssist.Webhook.すべて

属性名前	データの種類	説明
名前	string	Webhookの名前
desc(Optional)	string	Webhookの説明
url	文字列 - 有効な https URL	処理の情報を送信するサーバーエンドポイント。
ignore_src(オプション)	文字列	Webhook をトリガーしたクライアントIDを除外します。
サブスクリプション	サブスクリプションの配列	サブスクリプション管理対象とする処理。
ステータス	+10、-10（無効）または1（有効）	Webhookのステータス
hook_id	長	インスタンス内のhook項目のプライマリキー
event_id	整数	イベントのID
dept_ids	長[]	複数の部署IDを即座に取得