Webhookの利用
Webhookは、ある特定の操作が行われた時に、予め登録しておいた送信先URLに対して、操作に関連するデータを自動送信する仕組みです。
Webhookを活用することで、SynViz S2と外部システムの連携等を行うことができます。
Webhookは以下の場合に実行されます。
画面から対象の操作をおこなった場合（※スマートデバイスから操作した場合も含みます）
対象の操作に関連するWeb APIを実行した場合（※/batchで実行したケースも含みます）
Excel連携セットなどのツールから、対象の操作に関連するデータ更新を実行した場合
ここでは、Webhookに関する操作について説明します。
このセクションの内容は以下のとおりです。
システム構成イメージ
SynViz S2が想定する、Webhookを利用する際のシステム構成イメージは以下のとおりです。
SynViz S2と外部システムの間に、「中間サーバ」を設置します。
中間サーバの役割はシステム管理者マニュアルの「中間サーバの役割」、中間サーバの構築例はシステム管理者マニュアルの「中間サーバ構築手順」を参照ください。
Webhookの種類
SynViz S2では、Webhookを以下の3種類に分類します。
種類 |
説明 |
|---|---|
システムWebhook |
SynViz S2のシステム全体に対して実行されるWebhook。 |
プロジェクトWebhook |
特定のプロジェクトに対して作成され、原則そのプロジェクトでのみ利用可能なWebhook。 |
プロジェクト共有Webhook |
複数のプロジェクトで共用利用することを目的に作成されるWebhook。 |
システムWebhookとプロジェクトWebhookは、作成直後、自動で有効になります。
一方、プロジェクト共有Webhookは、作成しただけでは実行されません。 プロジェクト共有Webhookを利用したいプロジェクトに取り込むことで、実行されるようになります。
発火イベント一覧
発火イベントは、Webhookが実行される条件となる操作です。 Webhookの種類によって、設定できる発火イベントが異なります。
システム関連発火イベント
システムWebhookで設定できる発火イベントを以下に示します。
発火イベント名 |
説明 |
|---|---|
プロジェクト登録 |
新規プロジェクト作成時に実行されます。テンプレートからプロジェクトを作成した場合も実行されます。以下の場合は実行されません。
|
プロジェクト削除 |
プロジェクト削除時に実行されます。以下の場合は実行されません。
|
プロジェクト関連発火イベント
プロジェクトWebhookとプロジェクト共有Webhookで設定できる発火イベントを以下に示します。
発火イベント名 |
説明 |
|---|---|
プロジェクト基本情報更新 |
プロジェクトの基本情報編集時に実行されます。 以下の場合は実行されません。
|
プロジェクトメンバ登録 |
プロジェクトメンバを追加した時に実行されます。 |
プロジェクトメンバ更新 |
プロジェクトメンバ情報を編集した時に実行されます。プロジェクトにおける役割を変更した場合や、リソースとして使用の有無を変更した場合が該当します。 |
プロジェクトメンバ削除 |
プロジェクトメンバをプロジェクトから外した場合に実行されます。 |
履歴登録 |
以下のいずれかの操作を行った場合に実行されます。
ガントチャートの操作などにより、自動的に新規履歴が作成された場合は実行されません。 |
履歴更新 |
以下のいずれかの操作を行った場合に実行されます。
|
スケジュール変更 |
ガントチャートのスケジュールに関連するオブジェクトに対して登録 / 更新 / 削除操作が行われた場合に実行されます。対象は以下のとおりです。
|
実績情報変更 |
アクティビティ / マイルストーン / チェック項目 / サマリアクティビティに対して実績情報を登録 / 更新 / 削除した場合に実行されます。「完了にする」操作を実行した場合も実行されます。 |
作業見込み登録 / 更新 |
アクティビティまたはマイルストーンに対して、作業見込みを登録 / 更新した場合に実行されます。 |
作業見込み削除 |
アクティビティまたはマイルストーンに紐づいている作業見込みを削除した場合に実行されます。 |
添付ファイル登録 |
添付ファイルまたはURLを新規登録した場合に実行されます。登録済みのファイルを別のファイルに変更した場合や、URLを別のURLに変更した場合も実行されます。 |
添付ファイル更新 |
添付ファイルまたはURLの属性を更新した場合に実行されます。登録済みのファイルを別のファイルに変更した場合や、URLを別のURLに変更した場合は「添付ファイル登録」が実行されるため、「添付ファイル更新」は実行されません。 |
添付ファイル削除 |
添付ファイルまたはURLを削除した場合に実行されます。 |
実績工数変更 |
アクティビティに対して実績工数を登録 / 更新 / 削除した場合に実行されます。 |
タスクをサブプロジェクトに変換 |
タスクに対して「サブプロジェクトに変換」操作をした場合に実行されます。 |
サブプロジェクトをタスクに変換 |
サブプロジェクトに対して「タスクに変換」操作をした場合に実行されます。 |
注意
削除操作をおこなったオブジェクト配下に他のオブジェクトが存在する場合、削除操作をおこなったオブジェクトに対してのみ削除イベントが発生します。配下にある他のオブジェクトに対して、削除イベントは発生しません。
例えば、アクティビティが配置されているタスクを削除した場合、タスクに対してのみ削除イベントが発生し、アクティビティに対しては発生しません。
Webhookの操作
Webhookに対して、追加・共有Webhookの追加・編集・有効化・無効化・実行状況の確認・削除（/ 解除）操作をすることができます。
Webhookの種類によって、実施可能な操作や、操作を行うための画面構成が異なります。
システムWebhookまたはプロジェクト共有Webhookの場合は管理メニューの「Webhook」、 プロジェクトWebhookの場合はプロジェクトホームの「Webhook」を参照してください。