イベント
Webhook を送るきっかけと、イベントごとの決まりです。
送信データの event で、何がきっかけの送信かを示します。
| event | きっかけ | 設定の画面の名前 |
|---|---|---|
project.created | 案件の作成。案件のコピーで作ったときも含みます | 案件の作成 |
project.updated | 案件の中身の変更。案件の項目、アサインしたスタッフ、機材の予約、手入力の機材の変更をすべて含みます | 案件の更新 |
project.cancelled | 案件のキャンセル。まとめてキャンセルしたときも含みます | 案件のキャンセル |
schedule_entry.created | スタッフの予定の作成。まとめて作ったときは予定ごとに送ります | 予定の作成 |
schedule_entry.updated | スタッフの予定の変更 | 予定の更新 |
schedule_entry.deleted | スタッフの予定の削除 | 予定の削除 |
document.sent | 書類作成の画面で「Webhookで送信」を選んだとき | 書類作成からの送信 |
スタッフの予定は、休みや社内の業務など、案件に属さない予定です。案件のシフトは project.* の送信データに含まれます。
送る単位
- 操作の保存が成功したときだけ、案件1件、予定1件ごとに送ります。1回の操作で複数の案件が変わったときは、案件ごとに送ります。
- 保存しても値が変わらなかったときは送りません。
- 同じ案件や予定への続けての変更は、1回の送信にまとめます。まとめ方は送信の挙動をご覧ください。
個別の決まり
- 案件のロックの変更は送りません。案件の中身ではないためです。
- ほかの操作に伴って案件の中身が変わったときも、
project.updatedとして送ります。 - 機材を廃棄して予約が解除された案件には、
changesを["equipment"]として送ります。予約を残した廃棄や、在庫の数だけを減らした廃棄など、案件の予約が変わらない廃棄では送りません。 - 予約の付け替えは同じ案件の中での機材や期間の変更のため、その案件1件に送ります。
- 案件のコピーは、案件の作成と予約の作成が続けて保存されるため、通常は
project.createdの1回にまとまって届きます。 - 機材、機材カテゴリ、スタッフ、セクション、役職などのマスタの変更や削除、スタッフの無効化は送りません。案件の中身の変更ではないためです。マスタの値は次に送るときの送信データに反映されます。