ウェブフックについて

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

Webhookは、HTTPコールバックまたはプッシュAPIであり、サードパーティアプリケーションに自動でリアルタイム通知を送信します。通知は、特定の処理を実行した際に送信されます。

開始する前に、次の点を確認してください。

Webhookを利用するには、HTTP URLを使用してご利用のアプリケーションとサードパーティツールを連携する必要があります。このURLは、特定の処理が実行された際にデータを受け取ります。いずれかの処理に関連する操作が実行されると、データがこのURLに送信されます。
トリガーは、更新が発生した際に通知を送信する一連の処理です。

Webhook項目の定義済みセット

項目名	目的	制限事項	必須項目
Webhook名	Webhook名を入力してください	150文字以内	これは必須項目です
説明	Webhookの説明を入力してください	20,000文字
URL	1. サードパーティアプリケーションのREST APIのURLを入力してください。 2. 処理が実行されると、HTTPリクエストが実行済みとなるURLです。	200文字	必須項目です
タブ	WebhookはZoho Sprintsにおいてタブごとに設定されます。各タブにWebhookを作成できます。		これは必須項目です
Trigger 処理	1. 各タブには、それぞれ対応するTrigger処理があります。 2. 選択したタブに応じて、Trigger処理を選択してください。 3. 処理が実行されると、URLが実行済みとなります。		これは必須項目です
メソッド	イベント用のAPIメソッドを選択してください。 - POST - PUT - 削除 - 取得する		これは必須項目です
項目パラメーター	1. パラメーターは特定のタブ（projectid、sprintidなど）に関連付けられています。 2. パラメーターはスタンダード形式（JSON、XML、名前=値など）またはユーザー定義形式で追加できます。	25 パラメーター
カスタムパラメーター	1. これは特定のタブに関連付けられていない一般パラメーターです。 2. カスタムパラメーターは主に、Webhookをトリガーする際に使用するAPIキーやoAuthトークンなどを送信するために利用されます。	10 パラメーター
Header パラメーター	HTTPリクエストにheaderパラメーターを定義することもできます。	10 パラメーター
URL プレビューする	1. すべてのパラメーターが付与されたWebhook URLのプレビューです。 2. このURLは、サードパーティアプリケーションへの通知に使用中です。	Read-only 方法

機能の動作

Webhook URLは必ず http://、https://、または www. で始まる必要があります。
各タブごとにWebhookは最大25件まで作成できます。
Webhookは特定のタブにのみ関連付けることができます。一度関連付け済みになると、他のタブに関連付けることはできません。
失敗したWebhook通話の詳細およびWebhookのログは、直近5日分のみ表示できます。
Webhookが5回連続で失敗した場合、そのURLは一時停止されます。再度有効化する必要があります。

エラーコード

Zoho Sprintsは、Webhookの実行が次の値と等しくない場合、以下のエラーコードを表示します。

HTTP ステータスエラーコード	理由
400 Bad Request	パラメーターが不足しています
401 Unauthorized	oAuthトークンが無効です
402 Request 失敗	パラメーターは有効ですが、リクエストが失敗しました
404 Not Found	リクエストした商品が存在しません
500, 502, 503, 504 Server Errors	サードパーティアプリケーションに問題があります

例

Zoho Sprintsでスプリントが作成された際に、それをZoho Projectsのマイルストーンとして追加します。

必要条件

Zoho Projectsのアカウント
APIへのアクセス権限

手順

1.Zoho Projectsでポータルを作成

Zoho Projectsでポータルとプロジェクトを作成します。

2.Zoho SprintsでWebhookを設定

Webhook作成フォームの項目に値を入力します。
Webhook名を入力します。ここでは「Milestone - Sprints」としています。
URL欄には、サードパーティアプリケーションのURLを入力します。ここではZoho Projectsがサードパーティアプリケーションです。

Webhook URLは必ずhttps://、http://、またはwww.で始めてください。

Webhook URLの説明を入力してください。

3.タブを選択し、処理をトリガー

Webhookの目的は、Zoho Sprintsで作成したスプリントをZoho Projectsのマイルストーンとして追加することです。この操作では「Sprints」タブを使用します。
Sprintタブを選択します。
トリガーイベントとして「Sprint Added」を選択します。また、Sprintの更新、Sprintの削除、Sprintの開始、Sprintの完了など、他の処理も選択できます。
メソッドは「POST」を選択します。

4. パラメーターをユーザー定義形式で指定