📩
変更承認のWebhook通知
Webhookの仕様については下記をご覧ください。ご不明点がございましたら弊社カスタマーサクセスまでお問い合わせください。
【通知の送信タイミング】
変更の承認をトリガーとしてWebhook通知が指定したURL宛に送信されます。
【通知条件と通知内容】
承認された変更に、下記の通知条件と合致する変更が含まれていた場合に、通知が送信されます。
| 名称 | 条件 | 通知される内容 |
|---|---|---|
| 入社 | 任意の会社へ所属をした時（兼務追加も含まれる） | 「入社日」時点での全属性*1 |
| 退職 | 任意の会社から所属が外れた時*2（兼務解除も含まれる） | 「退職日」時点での全属性*1 |
| 雇用形態変更 | 会社への所属追加・解除以外の操作で、任意の会社での雇用形態が追加・変更・削除されたとき | 「雇用形態変更」発生日時点での全属性*1 |
| 入社取り消し | 「入社取り消し」されたとき ※ 現在「入社取り消し」が再入社の取り消しだった場合は動作しません | 最初の「入社日」時点での全属性*1 |
| メンバー情報変更 | メンバーに関するあらゆる変更（ロールの付与、剥奪や入退社予定日の変更も含む）が承認されたとき。※ 入社取り消し、再入社取り消しも含みます | 1. 「変更予定日*3」時点との変更が適用される前の全属性*1 2. 属性情報の値の変更の種別（追加、削除など） 3. webhookをトリガーしたイベント情報 |
*1 全属性： Webhookで出力する属性は下記の条件を満たす属性
- EntityType:
- ReferenceType: のどれか
*2 所属が外れた時：ただし、以下の場合は通知しない
- 所属している会社が削除されたことによって、メンバーの所属が外れた時
*3 「退社予定日の変更」においては変更日時点だとメンバーに関する全ての情報がnullになってしまう可能性があるため、例外的に退社日の情報を通知する。
- 例: 2023/03/31を退社予定日にした場合、YESODの変更日としては2023/04/01になるが、そのメンバーが退社する2023/03/31時点の情報を通知する。
*4 「再入社取り消し」の場合の通知は以下のパターンになる
- メンバー情報変更をONにして他の項目をOFFにした場合
- Webhook通知される。
- メンバー情報変更()に変更データ詳細が含まれる
- メンバー情報変更をONにして他の項目をONにした場合
- Webhook通知される。
- メンバー情報変更()に変更データ詳細が含まれる
- 他のONした項目(入社取り消しの場合は)はが表示される
- メンバー情報変更をOFFにして、他の項目をONにした場合
- Webhook通知されない。
【スキーマ情報】
Webhookに関するスキーマ情報は下記ページをご参照ください。
【通知テスト】
Webhook通知の作成後、YESOD画面から通知テストを行うことが可能です。画面右の「テスト」をクリックしてください。
設定した通知条件に合うダミーのペイロードが設定されたURLに送信されます。
