Webhookについて

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

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

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

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

利用可能プラン: Premier およびエンタープライズプラン

Webhook 項目の定義済みセット

項目名	目的	制限事項	必須項目
Webhook 名	Webhook 名を入力します。	150 文字	必須項目です
説明	Webhook の説明を入力します。	20000 文字
URL	1. サードパーティアプリケーションの REST API URL を入力します。 2. 処理が実行されたときに HTTP リクエストが送信される URL です。	200 文字	必須項目です
タブ	Zoho Sprints では、Webhook はタブごとに設定されます。各タブに対して Webhook を作成できます。		必須項目です
トリガー処理	1. 各タブには、それぞれに対応するトリガー処理があります。 2. 選択したタブに基づいて、トリガー処理を選択します。 3. 処理が実行されると、URL が呼び出されます。		必須項目です
メソッド	イベントに使用する API メソッドを選択します。 - POST - PUT - DELETE - GET		必須項目です
項目パラメーター	1. 特定のタブに関連付けられているパラメーター（projectid、sprintid など）。 2. パラメーターは、標準形式（JSON、XML など、または名前=値）またはユーザー定義形式で追加できます。	25 パラメーター
カスタムパラメーター	1. 特定のタブに関連付けられていない汎用パラメーターです。 2. カスタムパラメーターは主に、Webhook のトリガーに使用する API キーや OAuth トークンなどを送信するために使用します。	10 パラメーター
ヘッダーパラメーター	HTTP リクエスト内でヘッダーパラメーターを定義することもできます。	10 パラメーター
URL プレビュー	1. すべてのパラメーターが付加された Webhook URL のプレビューです。 2. この URL は、サードパーティアプリケーションへの通知に使用されます。	読み取り専用

機能の動作

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 Failed	パラメーターは有効ですが、リクエストが失敗しました
404 Not Found	リクエストされたリソースが存在しません
500, 502, 503, 504 Server Errors	サードパーティアプリケーション側で問題が発生しています

例

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

要件

Zoho プロジェクトのアカウント。
API にアクセスする権限。

手順

1. Zoho プロジェクトでポータルを作成する

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

2. Zoho Sprints で Webhook を設定する

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

Webhook URL は必ず https://、http://、または www. から始まる必要があります。

Webhook URL の説明を入力します。

3. タブとトリガー処理を選択する

この Webhook の目的は、ユーザーが Zoho Sprints でスプリントを作成したときに、それを Zoho プロジェクトのマイルストーンとして追加することです。ここでは「Sprints」タブを使用します。
タブで「Sprint」を選択します。
トリガーイベントとして「Sprint Added」を選択します。また、「Sprint Updated」「Sprint Deleted」「Sprint Started」「Sprint Completed」などの他の処理を選択することもできます。
メソッドとして POST を選択します。

4. ユーザー定義形式でパラメーターを設定する