Webhook設定

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

Webhookを使用すると、Zoho BugTrackerからサードパーティアプリケーションへHTTP通知を自動送信できます。Webhookでは、独自のHTTP URLを設定して特定のビジネスルールに関連付けることで、バグに関する通知プロセス全体を自動化できます。Webhookの詳細については、WebHooks.orgをご参照ください。

Webhookの設定

以下の順に移動します：→［バグトラッカー］→［Webhook］。
［Webhookの追加］をクリックします。
Webhookページで、必要なパラメーターをすべて指定します。
［保存］をクリックします。

Webhook設定の項目一覧

項目名	説明	データ型	制約
［名前］	Webhook名を指定します。	テキスト	100文字
［通知先URL］	サードパーティアプリケーションのREST API URLを指定します。	URL	1000文字
［メソッド］	APIメソッドの種類として、POSTまたはGETを選択します。初期設定では、POSTメソッドが選択されています。	ラジオボタン	-
［バグパラメーターの追加］	パラメーターは、標準形式またはユーザー定義形式（xml、jsonなど）のいずれかで追加できます。パラメーター名を指定します。また、バグの項目から選択した対応するパラメーター値を指定します。これらのパラメーターは、サードパーティに対してWebhookを実行するうえで重要です。	テキスト	3000文字
［カスタムパラメーターの追加］	Webhookのパラメーター名と対応する値を指定します。このキーと値の組み合わせは、主に認証トークンやAPIキーなどの送信に使用されます。	テキスト	3000文字
［URLのプレビュー］	サードパーティアプリケーションに通知する完全なWebhook URLをプレビューします。	読み取り専用	読み取り専用

Webhookとビジネスルールの関連付け

［ビジネスルール］で、［ルールの詳細］→［条件］→［処理］に移動します。
［処理］で、［Webhookの呼び出し］をクリックします。
新しいWebhookを作成するにはをクリックし、ビジネスルールで既存のWebhookを呼び出すにはをクリックします。
［ルールの保存］をクリックします。

Webhook連携のテスト

ビジネスルールの条件に合わせて、Zoho BugTrackerにテストデータを追加します。
使用しているアプリケーションで、Webhook通知を介してZoho BugTrackerから受信した更新／データを確認します。
エラーやデータの不一致がある場合は、Zoho BugTrackerでWebhook設定を変更します。
Zoho BugTrackerから使用しているアプリケーションに目的の結果が届くまで、テストを続けます。

Webhookでは、バグ関連パラメーター（バグのタイトル、ステータス、担当者など）とカスタムパラメーターの両方に対応しています。

既知の制限事項

Webhookごとに使用できるのは、バグ関連パラメーター10件とカスタムパラメーター5件のみです。
ユーザー定義形式（xml、jsonなど）のバグ関連パラメーターは1件のみ使用できます。
- ユーザー定義形式のバグ関連パラメーターの例：<bug-data><title>${Bug.BugTitle}</title><key>${Bug.BugKey}</key></Bug-data>
Webhookはビジネスルールからのみ実行されます。つまり、ビジネスルールが実行されると、関連付けられているWebhookが呼び出されます。
1つのビジネスルールに関連付けられるWebhookは1件のみですが、複数のビジネスルールを同じWebhookに関連付けることができます。
Webhookの呼び出しは1日あたり1000件までです。
失敗したWebhook実行は再試行されません。
Webhookの呼び出しが10回連続で失敗すると、Webhookは無効化されます。
1日のWebhookの呼び出し上限に達した場合、または連続した失敗によりWebhookが無効になった場合、メール通知は送信されません。
Webhookの失敗は監査され、Webhookの失敗ページには直近100件の失敗のみが表示されます。