Webhook概要

SmartHR Webhook の仕様について

設定方法

Webhook の設定は管理画面の「外部システム連携」より行えます。
設定の際には、以下の項目をご登録いただきます。
項目説明
URLWebhook から POST されるデータを受け取る URL
EventWebhook 発動のトリガーとなるイベント種別
SecretToken
(任意)
SmartHR からの送信データであることを確認するためのシークレットトークン
このトークンは X-SmartHR-Token というリクエストヘッダで送信されます。
説明 (任意)登録した Webhook 設定の説明

データの受信

Webhook では指定された URL に POST でデータが送信されます。SmartHR サーバからアクセスできない URL やプライベートネットワークアドレスではご利用いただけません。データ受信後はステータスコード 200 番台で応答するようお願いいたします。
200 番台以外のレスポンスを検知した場合、もしくは60秒以内に応答がなかった場合は、送信失敗とみなしてリトライを行います。
リトライ送信は約3日間で最大17回試行されます。(サンドボックス環境では約8分間で最大5回施行されます)
リトライ上限に達して送信失敗した場合は、対象の Webhook が無効化されます。

イベント

Webhook が発動されるイベントには以下のものがあります。
イベントID発動タイミング送信オブジェクト
crew_created従業員データが作成されたタイミングで発動Crew
crew_updated従業員データが更新されたタイミングで発動Crew
crew_deleted従業員データが完全に削除されたタイミングで発動Crew
crew_imported従業員データがファイルを使って取り込まれたタイミングで発動CrewImportResult
dependent_created家族データが作成されたタイミングで発動Dependent
dependent_updated家族データが更新されたタイミングで発動Dependent
dependent_deleted家族データが完全に削除されたタイミングで発動Dependent
dependent_imported家族データがファイルを使って取り込まれたタイミングで発動DependentImportResult
workflow_approved申請の最終ステップが承認されたタイミングで発動Workflow

送信データ

Webhook から POST されるデータは、以下の構造を持つ JSON となっています。
プロパティ内容
eventString発動したイベントの ID
triggered_atStringイベントが発動した日時
senderCrewイベントを発動させた従業員。従業員データと紐付かないアカウントの場合は null となります。
イベントごとの送信オブジェクト-詳細は下記をご参照ください。
各イベントが持つ送信オブジェクトは以下の通りです。

Crew

(プロパティ名: crew
「従業員」エンドポイントで取得可能な Crew オブジェクトと同じ構造を持ちますが、出力される項目が限定されています。Payload の全体イメージは以下の通りです。
{
  "id": "string",
  "user_id": "string",
  "biz_establishment_id": "string",
  "emp_type": "board_member",
  "employment_type": {
    "id": "string",
    "name": "string",
    "preset_type": "board_member",
    "updated_at": "2021-03-17T00:00:00.000Z",
    "created_at": "2021-03-17T00:00:00.000Z"
  },
  "emp_status": "employed",
  "emp_code": "string",
  "last_name": "string",
  "first_name": "string",
  "last_name_yomi": "string",
  "first_name_yomi": "string",
  "business_last_name": "string",
  "business_first_name": "string",
  "business_last_name_yomi": "string",
  "business_first_name_yomi": "string",
  "birth_at": "2021-03-17",
  "gender": "male",
  "tel_number": "string",
  "email": "string",
  "address": {
    "id": "string",
    "country_number": "string",
    "zip_code": "string",
    "pref": "string",
    "city": "string",
    "street": "string",
    "building": "string",
    "literal_yomi": "string"
  },
  "address_head_of_family": "string",
  "address_relation_name": "string",
  "resident_card_address": {
    "id": "string",
    "country_number": "string",
    "zip_code": "string",
    "pref": "string",
    "city": "string",
    "street": "string",
    "building": "string",
    "literal_yomi": "string"
  },
  "resident_card_address_head_of_family": "string",
  "resident_card_address_relation_name": "string",
  "profile_images": [
    {
      "size_type": "thumb",
      "height": 20,
      "width": 20,
      "url": "string"
    },
    {
      "size_type": "small",
      "height": 120,
      "width": 120,
      "url": "string"
    },
    {
      "size_type": "medium",
      "height": 230,
      "width": 230,
      "url": "string"
    },
    {
      "size_type": "large",
      "height": 500,
      "width": 500,
      "url": "string"
    },
    {
      "size_type": "original",
      "height": 20,
      "width": 20,
      "url": "string"
    }
  ],
  "emergency_address": {
    "id": "string",
    "country_number": "string",
    "zip_code": "string",
    "pref": "string",
    "city": "string",
    "street": "string",
    "building": "string",
    "literal_yomi": "string"
  },
  "emergency_relation_name": "string",
  "emergency_last_name": "string",
  "emergency_first_name": "string",
  "emergency_last_name_yomi": "string",
  "emergency_first_name_yomi": "string",
  "emergency_tel_number": "string",
  "department": "string",
  "departments": [
    {
      "id": "string",
      "name": "string",
      "position": 0,
      "code": "string",
      "parent": {},
      "children": [
        {}
      ],
      "updated_at": "2021-03-17T00:00:00.000Z",
      "created_at": "2021-03-17T00:00:00.000Z"
    }
  ],
  "position": "string",
  "occupation": "string",
  "entered_at": "2021-03-17",
  "resigned_at": "2021-03-17",
  "resigned_reason": "string",
  "resume1": {
    "file_name": "string",
    "url": "string"
  },
  "resume2": {
    "file_name": "string",
    "url": "string"
  },
  "bank_accounts": [
    {
      "bank_code": "string",
      "bank_branch_code": "string",
      "account_type": "saving",
      "account_number": "string",
      "account_holder_name": "string",
      "bankbook_image": {
        "file_name": "string",
        "content": "string"
      },
      "bank_account_setting_id": "string"
    }
  ],
  "nearest_station_and_line": "string",
  "commutation_1_expenses": 0,
  "commutation_1_period": "commutation_period_1_month",
  "commutation_1_single_fare": 0,
  "commutation_2_expenses": 0,
  "commutation_2_period": "commutation_period_1_month",
  "commutation_2_single_fare": 0,
  "emp_ins_qualified_at": "2021-03-17",
  "emp_ins_disqualified_at": "2021-03-17",
  "soc_ins_qualified_at": "2021-03-17",
  "soc_ins_disqualified_at": "2021-03-17",
  "having_spouse": true,
  "custom_fields": [
    {
      "value": "string",
      "template": {
        "id": "string",
        "name": "string",
        "type": "date",
        "elements": [
          {
            "id": "string",
            "name": "string",
            "physical_name": "string",
            "position": 0
          }
        ],
        "group_id": "string",
        "group": {
          "id": "string",
          "name": "string",
          "position": 0,
          "access_type": "read_and_update",
          "templates": [
            {}
          ],
          "updated_at": "2021-03-17T00:00:00.000Z",
          "created_at": "2021-03-17T00:00:00.000Z"
        },
        "hint": "string",
        "scale": 0,
        "separated_by_commas": true,
        "position": 0,
        "updated_at": "2021-03-17T00:00:00.000Z",
        "created_at": "2021-03-17T00:00:00.000Z"
      }
    }
  ],
  "created_at": "2021-03-17T00:00:00.000Z",
  "updated_at": "2021-03-17T00:00:00.000Z"
}

CrewImportResult

(プロパティ名: crew_import_resultファイルの取り込みによって一括で登録・更新された従業員情報がまとめて出力されます。登録された従業員は created_crews に、更新された従業員は updated_crews にそれぞれ分けられ、Crew のリストとして表現されます。Payload の全体イメージは以下の通りです。
{
  "event": "crew_imported",
  "sender": null,
  "triggered_at": "2021-03-17T00:00:00+09:00",
  "crew_import_result": {
    "created_crews": [],
    "updated_crews": []
  }
}

Dependent

(プロパティ名: dependent「家族情報」エンドポイントで取得可能な Dependent オブジェクトと同じ構造を持ちますが、出力される項目が限定されています。Payload の全体イメージは以下の通りです。
{
  "id": "string",
  "crew_id": "string",
  "relation": {
    "id": "string",
    "name": "string",
    "preset_type": "string",
    "is_child": true,
    "position": 0,
    "created_at": "2021-03-17T00:00:00.000Z",
    "updated_at": "2021-03-17T00:00:00.000Z"
  },
  "is_spouse": true,
  "last_name": "string",
  "first_name": "string",
  "last_name_yomi": "string",
  "first_name_yomi": "string",
  "created_at": "2021-03-17T00:00:00.000Z",
  "updated_at": "2021-03-17T00:00:00.000Z"
}

DependentImportResult

(プロパティ名: dependent_import_resultファイルの取り込みによって一括で登録・更新された家族情報がまとめて出力されます。登録された家族は created_dependents に、更新された家族は updated_dependents にそれぞれ分けられ、Dependent のリストとして表現されます。Payload の全体イメージは以下の通りです。
{
  "event": "dependent_imported",
  "sender": null,
  "triggered_at": "2021-03-17T00:00:00+09:00",
  "dependent_import_result": {
    "created_dependents": [],
    "updated_dependents": []
  }
}

Workflow

(プロパティ名: workflow申請情報、申請によって登録・更新された従業員情報、申請によって登録・更新・削除された家族情報、申請者情報がまとめて出力されます。登録された従業員は created_crew に、更新された従業員は updated_crew にそれぞれ分けられ、Crewのオブジェクトとして表現されます。登録された家族は created_dependents に、更新された家族は updated_dependents に、削除された家族は deleted_dependents にそれぞれ分けられ、Dependent のリストとして表現されます。従業員情報および申請者情報は「従業員」エンドポイントで取得可能なCrewオブジェクト、家族情報は「家族情報」エンドポイントで取得可能なDependentオブジェクトと同じ構造、同じ項目で出力されます。Payload の全体イメージは以下の通りです。
{
  "id": "string",
  "name": "string",
  "input_requested_at": "2021-03-17T00:00:00.000Z",
  "review_requested_at": "2021-03-17T00:00:00.000Z",
  "approved_at": "2021-03-17T00:00:00.000Z",
  "valid_at": "2021-03-17",
  "created_at": "2021-03-17T00:00:00.000Z",
  "updated_at": "2021-03-17T00:00:00.000Z",
  "created_crew": null,
  "updated_crew": {
    "id": "string",
    "user_id": "string",
    "biz_establishment_id": "string",
    "biz_establishment": {
      "id": "string",
      "hel_ins_type": "kyokai_kenpo",
      "hel_ins_name": "string",
      "hel_ins_ref_code": "string",
      "name": "string",
      "soc_ins_name": "string",
      "soc_ins_owner_id": "string",
      "soc_ins_owner": "string",
      "soc_ins_address": {
        "country_number": "string",
        "zip_code": "string",
        "pref": "string",
        "city": "string",
        "street": "string",
        "building": "string",
        "literal_yomi": "string"
      },
      "soc_ins_tel_number": "string",
      "soc_ins_ref_code": "string",
      "soc_ins_number": "string",
      "lab_ins_name": "string",
      "lab_ins_owner_id": "string",
      "lab_ins_owner": "string",
      "lab_ins_address": {
        "country_number": "string",
        "zip_code": "string",
        "pref": "string",
        "city": "string",
        "street": "string",
        "building": "string",
        "literal_yomi": "string"
      },
      "lab_ins_tel_number": "string",
      "lab_ins_number": "string",
      "emp_ins_number": "string",
      "sr": {
        "id": "string",
        "first_name": "string",
        "last_name": "string",
        "first_name_yomi": "string",
        "last_name_yomi": "string",
        "title": "string",
        "association_pref": "string",
        "agent_type": "submit_agent",
        "tel_number": "string",
        "address": {
          "country_number": "string",
          "zip_code": "string",
          "pref": "string",
          "city": "string",
          "street": "string",
          "building": "string",
          "literal_yomi": "string"
        }
      },
      "jurisdiction_tax": "string",
      "salary_payer_address": {
        "country_number": "string",
        "zip_code": "string",
        "pref": "string",
        "city": "string",
        "street": "string",
        "building": "string",
        "literal_yomi": "string"
      },
      "updated_at": "2025-06-13T02:58:01.166Z",
      "created_at": "2025-06-13T02:58:01.166Z"
    },
    "emp_code": "string",
    "emp_type": "board_member",
    "employment_type": {
      "id": "string",
      "name": "string",
      "preset_type": "board_member",
      "code": "string",
      "updated_at": "2025-06-13T02:58:01.166Z",
      "created_at": "2025-06-13T02:58:01.166Z"
    },
    "emp_status": "employed",
    "last_name": "string",
    "first_name": "string",
    "last_name_yomi": "string",
    "first_name_yomi": "string",
    "business_last_name": "string",
    "business_first_name": "string",
    "business_last_name_yomi": "string",
    "business_first_name_yomi": "string",
    "preferred_last_name": "string",
    "preferred_first_name": "string",
    "preferred_last_name_yomi": "string",
    "preferred_first_name_yomi": "string",
    "birth_at": "2025-06-13",
    "gender": "male",
    "identity_card_image1": {
      "file_name": "string",
      "url": "string"
    },
    "identity_card_image2": {
      "file_name": "string",
      "url": "string"
    },
    "tel_number": "string",
    "address": {
      "country_number": "string",
      "zip_code": "string",
      "pref": "string",
      "city": "string",
      "street": "string",
      "building": "string",
      "literal_yomi": "string"
    },
    "address_image": {
      "file_name": "string",
      "url": "string"
    },
    "address_head_of_family": "string",
    "address_relation_name": "string",
    "email": "string",
    "profile_images": [
      {
        "size_type": "thumb",
        "height": 0,
        "width": 0,
        "url": "string"
      }
    ],
    "emergency_relation_name": "string",
    "emergency_last_name": "string",
    "emergency_first_name": "string",
    "emergency_last_name_yomi": "string",
    "emergency_first_name_yomi": "string",
    "emergency_tel_number": "string",
    "emergency_address": {
      "country_number": "string",
      "zip_code": "string",
      "pref": "string",
      "city": "string",
      "street": "string",
      "building": "string",
      "literal_yomi": "string"
    },
    "resident_card_address": {
      "country_number": "string",
      "zip_code": "string",
      "pref": "string",
      "city": "string",
      "street": "string",
      "building": "string",
      "literal_yomi": "string"
    },
    "resident_card_address_head_of_family": "string",
    "resident_card_address_relation_name": "string",
    "position": "string",
    "positions": [
      {
        "id": "string",
        "name": "string",
        "rank": 0,
        "code": "string",
        "created_at": "2025-06-13T02:58:01.166Z"
      }
    ],
    "grade": {
      "id": "string",
      "name": "string",
      "rank": 0,
      "created_at": "2025-06-13T02:58:01.166Z",
      "updated_at": "2025-06-13T02:58:01.166Z"
    },
    "job_category": {
      "id": "string",
      "name": "string",
      "created_at": "2025-06-13T02:58:01.166Z",
      "updated_at": "2025-06-13T02:58:01.166Z"
    },
    "occupation": "string",
    "entered_at": "2025-06-13",
    "resigned_at": "2025-06-13",
    "resigned_reason": "string",
    "resume1": {
      "file_name": "string",
      "url": "string"
    },
    "resume2": {
      "file_name": "string",
      "url": "string"
    },
    "emp_ins_insured_person_number": "string",
    "emp_ins_insured_person_number_image": {
      "file_name": "string",
      "url": "string"
    },
    "emp_ins_insured_person_number_unknown_reason_type": "no_work_experience",
    "emp_ins_qualified_at": "2025-06-13",
    "emp_ins_disqualified_at": "2025-06-13",
    "previous_workplace": "string",
    "previous_employment_start_on": "2025-06-13",
    "previous_employment_end_on": "2025-06-13",
    "soc_ins_insured_person_number": 0,
    "hel_ins_insured_person_number": 0,
    "basic_pension_number": "string",
    "basic_pension_number_image": {
      "file_name": "string",
      "url": "string"
    },
    "first_enrolling_in_emp_pns_ins_flag": true,
    "basic_pension_number_unknown_reason_type": "non_pensionable",
    "first_workplace": "string",
    "first_workplace_address_text": "string",
    "first_employment_start_on": "2025-06-13",
    "first_employment_end_on": "2025-06-13",
    "last_workplace": "string",
    "last_workplace_address_text": "string",
    "last_employment_start_on": "2025-06-13",
    "last_employment_end_on": "2025-06-13",
    "soc_ins_qualified_at": "2025-06-13",
    "soc_ins_disqualified_at": "2025-06-13",
    "having_spouse": true,
    "spouse_yearly_income": 0,
    "monthly_income_currency": 0,
    "monthly_income_goods": 0,
    "payment_period": {
      "id": "string",
      "name": "string",
      "period_type": "monthly",
      "updated_at": "2025-06-13T02:58:01.166Z",
      "created_at": "2025-06-13T02:58:01.166Z"
    },
    "monthly_base_salary": 0,
    "monthly_standard_income_updated_at": "2025-06-13",
    "monthly_standard_income_hel": 0,
    "monthly_standard_income_pns": 0,
    "nearest_station_and_line": "string",
    "commutation_1_expenses": 0,
    "commutation_1_period": "commutation_period_1_month",
    "commutation_1_single_fare": 0,
    "commutation_2_expenses": 0,
    "commutation_2_period": "commutation_period_1_month",
    "commutation_2_single_fare": 0,
    "foreign_resident_last_name": "string",
    "foreign_resident_first_name": "string",
    "foreign_resident_middle_name": "string",
    "foreign_resident_card_number": "string",
    "foreign_resident_card_image1": {
      "file_name": "string",
      "url": "string"
    },
    "foreign_resident_card_image2": {
      "file_name": "string",
      "url": "string"
    },
    "nationality_code": "string",
    "resident_status_type": "string",
    "resident_status_other_reason": "string",
    "resident_end_at": "2025-06-13",
    "having_ex_activity_permission": "permitted",
    "other_be_workable_type": "other_be_workable",
    "bank_accounts": [
      {
        "bank_code": "string",
        "bank_branch_code": "string",
        "account_type": "saving",
        "account_number": "string",
        "account_holder_name": "string",
        "bankbook_image": {
          "file_name": "string",
          "content": "string"
        },
        "bank_account_setting_id": "string"
      }
    ],
    "department": "string",
    "departments": [
      {
        "id": "string",
        "name": "string",
        "full_name": "string",
        "position": 0,
        "code": "string",
        "parent": "string",
        "children": [
          "string"
        ],
        "updated_at": "2025-06-13T02:58:01.166Z",
        "created_at": "2025-06-13T02:58:01.166Z"
      }
    ],
    "contract_type": "unlimited",
    "contract_start_on": "2025-06-13",
    "contract_end_on": "2025-06-13",
    "contract_renewal_type": "renewal",
    "tax_cd": "kou",
    "handicapped_type": "ordinary_handicapped",
    "handicapped_note_type": "string",
    "handicapped_note_delivery_at": "2025-06-13",
    "handicapped_image": {
      "file_name": "string",
      "url": "string"
    },
    "working_student_flag": true,
    "school_name": "string",
    "student_card_image": {
      "file_name": "string",
      "url": "string"
    },
    "enrolled_at": "2025-06-13",
    "working_student_income": 0,
    "employment_income_flag": true,
    "business_income_flag": true,
    "devidend_income_flag": true,
    "estate_income_flag": true,
    "widow_type": "widow",
    "widow_reason_type": "divorce",
    "widow_memo": "string",
    "custom_fields": [
      {
        "value": "string",
        "template": {
          "id": "string",
          "name": "string",
          "type": "date",
          "elements": [
            {
              "id": "string",
              "name": "string",
              "physical_name": "string",
              "position": 0
            }
          ],
          "group_id": "string",
          "group": {
            "id": "string",
            "name": "string",
            "position": 0,
            "access_type": "read_and_update",
            "templates": [
              "string"
            ],
            "updated_at": "2025-06-13T02:58:01.166Z",
            "created_at": "2025-06-13T02:58:01.166Z"
          },
          "hint": "string",
          "scale": 0,
          "separated_by_commas": true,
          "position": 0,
          "updated_at": "2025-06-13T02:58:01.166Z",
          "created_at": "2025-06-13T02:58:01.166Z"
        }
      }
    ],
    "created_at": "2025-06-13T02:58:01.166Z",
    "updated_at": "2025-06-13T02:58:01.166Z"
  },
  "created_dependents": [
    {
      "id": "string",
      "crew_id": "string",
      "relation_name": "string",
      "relation": {
        "id": "string",
        "name": "string",
        "preset_type": "string",
        "is_child": true,
        "position": 0,
        "created_at": "2025-06-13T02:59:37.685Z",
        "updated_at": "2025-06-13T02:59:37.685Z"
      },
      "is_spouse": true,
      "last_name": "string",
      "first_name": "string",
      "last_name_yomi": "string",
      "first_name_yomi": "string",
      "birth_at": "2025-06-13",
      "moved_at": "2025-06-13",
      "gender": "male",
      "job": "string",
      "basic_pension_number": "string",
      "basic_pension_number_image": {
        "file_name": "string",
        "url": "string"
      },
      "live_together_type": "living_together",
      "address": {
        "country_number": "string",
        "zip_code": "string",
        "pref": "string",
        "city": "string",
        "street": "string",
        "building": "string",
        "literal_yomi": "string"
      },
      "tel_number": "string",
      "handicapped_type": "ordinary_handicapped",
      "handicapped_note_type": "string",
      "handicapped_note_delivery_at": "2025-06-13",
      "handicapped_image": {
        "file_name": "string",
        "url": "string"
      },
      "remittance_to_relative": 0,
      "remittance_image1": {
        "file_name": "string",
        "url": "string"
      },
      "remittance_image2": {
        "file_name": "string",
        "url": "string"
      },
      "remittance_image3": {
        "file_name": "string",
        "url": "string"
      },
      "international_student": true,
      "international_student_image": {
        "file_name": "string",
        "url": "string"
      },
      "social_insurance_support_type": "unsupported",
      "income": 0,
      "monthly_income": 0,
      "soc_ins_qualified_at": "2025-06-13",
      "soc_ins_qualified_reason": "string",
      "soc_ins_disqualified_at": "2025-06-13",
      "disqualified_reason_type": "death",
      "disqualified_reason": "string",
      "tax_law_support_type": "unsupported",
      "tax_deduction_income": 0,
      "tax_deduction_qualified_at": "2025-06-13",
      "tax_deduction_qualified_reason": "string",
      "tax_deduction_disqualified_at": "2025-06-13",
      "tax_deduction_disqualified_reason_type": "death",
      "tax_deduction_disqualified_reason": "string",
      "maternity_handbook_image": {
        "file_name": "string",
        "url": "string"
      },
      "kinship_image": {
        "file_name": "string",
        "url": "string"
      },
      "created_at": "2025-06-13T02:59:37.685Z",
      "updated_at": "2025-06-13T02:59:37.685Z",
      "code": "string",
      "spouse_dependent_qualification_reason_type": "joined_employee_ins",
      "spouse_dependent_disqualification_reason_type": "dead",
      "spouse_dependent_disqualification_dead_at": "2025-06-13",
      "spouse_dependent_disqualification_reason": "string",
      "custom_fields": [
        {
          "value": "string",
          "template": {
            "id": "string",
            "name": "string",
            "type": "date",
            "elements": [
              {
                "id": "string",
                "name": "string",
                "physical_name": "string",
                "position": 0
              }
            ],
            "hint": "string",
            "scale": 0,
            "separated_by_commas": true,
            "position": 0,
            "created_at": "2025-06-13T02:59:37.685Z",
            "updated_at": "2025-06-13T02:59:37.685Z"
          },
          "created_at": "2025-06-13T02:59:37.685Z",
          "updated_at": "2025-06-13T02:59:37.685Z"
        }
      ]
    }
  ],
  "updated_dependents": [
    {
      "id": "string",
      "crew_id": "string",
      "relation_name": "string",
      "relation": {
        "id": "string",
        "name": "string",
        "preset_type": "string",
        "is_child": true,
        "position": 0,
        "created_at": "2025-06-13T02:59:37.685Z",
        "updated_at": "2025-06-13T02:59:37.685Z"
      },
      "is_spouse": true,
      "last_name": "string",
      "first_name": "string",
      "last_name_yomi": "string",
      "first_name_yomi": "string",
      "birth_at": "2025-06-13",
      "moved_at": "2025-06-13",
      "gender": "male",
      "job": "string",
      "basic_pension_number": "string",
      "basic_pension_number_image": {
        "file_name": "string",
        "url": "string"
      },
      "live_together_type": "living_together",
      "address": {
        "country_number": "string",
        "zip_code": "string",
        "pref": "string",
        "city": "string",
        "street": "string",
        "building": "string",
        "literal_yomi": "string"
      },
      "tel_number": "string",
      "handicapped_type": "ordinary_handicapped",
      "handicapped_note_type": "string",
      "handicapped_note_delivery_at": "2025-06-13",
      "handicapped_image": {
        "file_name": "string",
        "url": "string"
      },
      "remittance_to_relative": 0,
      "remittance_image1": {
        "file_name": "string",
        "url": "string"
      },
      "remittance_image2": {
        "file_name": "string",
        "url": "string"
      },
      "remittance_image3": {
        "file_name": "string",
        "url": "string"
      },
      "international_student": true,
      "international_student_image": {
        "file_name": "string",
        "url": "string"
      },
      "social_insurance_support_type": "unsupported",
      "income": 0,
      "monthly_income": 0,
      "soc_ins_qualified_at": "2025-06-13",
      "soc_ins_qualified_reason": "string",
      "soc_ins_disqualified_at": "2025-06-13",
      "disqualified_reason_type": "death",
      "disqualified_reason": "string",
      "tax_law_support_type": "unsupported",
      "tax_deduction_income": 0,
      "tax_deduction_qualified_at": "2025-06-13",
      "tax_deduction_qualified_reason": "string",
      "tax_deduction_disqualified_at": "2025-06-13",
      "tax_deduction_disqualified_reason_type": "death",
      "tax_deduction_disqualified_reason": "string",
      "maternity_handbook_image": {
        "file_name": "string",
        "url": "string"
      },
      "kinship_image": {
        "file_name": "string",
        "url": "string"
      },
      "created_at": "2025-06-13T02:59:37.685Z",
      "updated_at": "2025-06-13T02:59:37.685Z",
      "code": "string",
      "spouse_dependent_qualification_reason_type": "joined_employee_ins",
      "spouse_dependent_disqualification_reason_type": "dead",
      "spouse_dependent_disqualification_dead_at": "2025-06-13",
      "spouse_dependent_disqualification_reason": "string",
      "custom_fields": [
        {
          "value": "string",
          "template": {
            "id": "string",
            "name": "string",
            "type": "date",
            "elements": [
              {
                "id": "string",
                "name": "string",
                "physical_name": "string",
                "position": 0
              }
            ],
            "hint": "string",
            "scale": 0,
            "separated_by_commas": true,
            "position": 0,
            "created_at": "2025-06-13T02:59:37.685Z",
            "updated_at": "2025-06-13T02:59:37.685Z"
          },
          "created_at": "2025-06-13T02:59:37.685Z",
          "updated_at": "2025-06-13T02:59:37.685Z"
        }
      ]
    }
  ],
  "deleted_dependents": [
    {
      "id": "string",
      "crew_id": "string",
      "relation_name": "string",
      "relation": {
        "id": "string",
        "name": "string",
        "preset_type": "string",
        "is_child": true,
        "position": 0,
        "created_at": "2025-06-13T02:59:37.685Z",
        "updated_at": "2025-06-13T02:59:37.685Z"
      },
      "is_spouse": true,
      "last_name": "string",
      "first_name": "string",
      "last_name_yomi": "string",
      "first_name_yomi": "string",
      "birth_at": "2025-06-13",
      "moved_at": "2025-06-13",
      "gender": "male",
      "job": "string",
      "basic_pension_number": "string",
      "basic_pension_number_image": {
        "file_name": "string",
        "url": "string"
      },
      "live_together_type": "living_together",
      "address": {
        "country_number": "string",
        "zip_code": "string",
        "pref": "string",
        "city": "string",
        "street": "string",
        "building": "string",
        "literal_yomi": "string"
      },
      "tel_number": "string",
      "handicapped_type": "ordinary_handicapped",
      "handicapped_note_type": "string",
      "handicapped_note_delivery_at": "2025-06-13",
      "handicapped_image": {
        "file_name": "string",
        "url": "string"
      },
      "remittance_to_relative": 0,
      "remittance_image1": {
        "file_name": "string",
        "url": "string"
      },
      "remittance_image2": {
        "file_name": "string",
        "url": "string"
      },
      "remittance_image3": {
        "file_name": "string",
        "url": "string"
      },
      "international_student": true,
      "international_student_image": {
        "file_name": "string",
        "url": "string"
      },
      "social_insurance_support_type": "unsupported",
      "income": 0,
      "monthly_income": 0,
      "soc_ins_qualified_at": "2025-06-13",
      "soc_ins_qualified_reason": "string",
      "soc_ins_disqualified_at": "2025-06-13",
      "disqualified_reason_type": "death",
      "disqualified_reason": "string",
      "tax_law_support_type": "unsupported",
      "tax_deduction_income": 0,
      "tax_deduction_qualified_at": "2025-06-13",
      "tax_deduction_qualified_reason": "string",
      "tax_deduction_disqualified_at": "2025-06-13",
      "tax_deduction_disqualified_reason_type": "death",
      "tax_deduction_disqualified_reason": "string",
      "maternity_handbook_image": {
        "file_name": "string",
        "url": "string"
      },
      "kinship_image": {
        "file_name": "string",
        "url": "string"
      },
      "created_at": "2025-06-13T02:59:37.685Z",
      "updated_at": "2025-06-13T02:59:37.685Z",
      "code": "string",
      "spouse_dependent_qualification_reason_type": "joined_employee_ins",
      "spouse_dependent_disqualification_reason_type": "dead",
      "spouse_dependent_disqualification_dead_at": "2025-06-13",
      "spouse_dependent_disqualification_reason": "string",
      "custom_fields": [
        {
          "value": "string",
          "template": {
            "id": "string",
            "name": "string",
            "type": "date",
            "elements": [
              {
                "id": "string",
                "name": "string",
                "physical_name": "string",
                "position": 0
              }
            ],
            "hint": "string",
            "scale": 0,
            "separated_by_commas": true,
            "position": 0,
            "created_at": "2025-06-13T02:59:37.685Z",
            "updated_at": "2025-06-13T02:59:37.685Z"
          },
          "created_at": "2025-06-13T02:59:37.685Z",
          "updated_at": "2025-06-13T02:59:37.685Z"
        }
      ]
    }
  ],
  "applicant": {
    "id": "string",
    "user_id": "string",
    "biz_establishment_id": "string",
    "biz_establishment": {
      "id": "string",
      "hel_ins_type": "kyokai_kenpo",
      "hel_ins_name": "string",
      "hel_ins_ref_code": "string",
      "name": "string",
      "soc_ins_name": "string",
      "soc_ins_owner_id": "string",
      "soc_ins_owner": "string",
      "soc_ins_address": {
        "country_number": "string",
        "zip_code": "string",
        "pref": "string",
        "city": "string",
        "street": "string",
        "building": "string",
        "literal_yomi": "string"
      },
      "soc_ins_tel_number": "string",
      "soc_ins_ref_code": "string",
      "soc_ins_number": "string",
      "lab_ins_name": "string",
      "lab_ins_owner_id": "string",
      "lab_ins_owner": "string",
      "lab_ins_address": {
        "country_number": "string",
        "zip_code": "string",
        "pref": "string",
        "city": "string",
        "street": "string",
        "building": "string",
        "literal_yomi": "string"
      },
      "lab_ins_tel_number": "string",
      "lab_ins_number": "string",
      "emp_ins_number": "string",
      "sr": {
        "id": "string",
        "first_name": "string",
        "last_name": "string",
        "first_name_yomi": "string",
        "last_name_yomi": "string",
        "title": "string",
        "association_pref": "string",
        "agent_type": "submit_agent",
        "tel_number": "string",
        "address": {
          "country_number": "string",
          "zip_code": "string",
          "pref": "string",
          "city": "string",
          "street": "string",
          "building": "string",
          "literal_yomi": "string"
        }
      },
      "jurisdiction_tax": "string",
      "salary_payer_address": {
        "country_number": "string",
        "zip_code": "string",
        "pref": "string",
        "city": "string",
        "street": "string",
        "building": "string",
        "literal_yomi": "string"
      },
      "updated_at": "2025-06-13T02:58:01.166Z",
      "created_at": "2025-06-13T02:58:01.166Z"
    },
    "emp_code": "string",
    "emp_type": "board_member",
    "employment_type": {
      "id": "string",
      "name": "string",
      "preset_type": "board_member",
      "code": "string",
      "updated_at": "2025-06-13T02:58:01.166Z",
      "created_at": "2025-06-13T02:58:01.166Z"
    },
    "emp_status": "employed",
    "last_name": "string",
    "first_name": "string",
    "last_name_yomi": "string",
    "first_name_yomi": "string",
    "business_last_name": "string",
    "business_first_name": "string",
    "business_last_name_yomi": "string",
    "business_first_name_yomi": "string",
    "preferred_last_name": "string",
    "preferred_first_name": "string",
    "preferred_last_name_yomi": "string",
    "preferred_first_name_yomi": "string",
    "birth_at": "2025-06-13",
    "gender": "male",
    "identity_card_image1": {
      "file_name": "string",
      "url": "string"
    },
    "identity_card_image2": {
      "file_name": "string",
      "url": "string"
    },
    "tel_number": "string",
    "address": {
      "country_number": "string",
      "zip_code": "string",
      "pref": "string",
      "city": "string",
      "street": "string",
      "building": "string",
      "literal_yomi": "string"
    },
    "address_image": {
      "file_name": "string",
      "url": "string"
    },
    "address_head_of_family": "string",
    "address_relation_name": "string",
    "email": "string",
    "profile_images": [
      {
        "size_type": "thumb",
        "height": 0,
        "width": 0,
        "url": "string"
      }
    ],
    "emergency_relation_name": "string",
    "emergency_last_name": "string",
    "emergency_first_name": "string",
    "emergency_last_name_yomi": "string",
    "emergency_first_name_yomi": "string",
    "emergency_tel_number": "string",
    "emergency_address": {
      "country_number": "string",
      "zip_code": "string",
      "pref": "string",
      "city": "string",
      "street": "string",
      "building": "string",
      "literal_yomi": "string"
    },
    "resident_card_address": {
      "country_number": "string",
      "zip_code": "string",
      "pref": "string",
      "city": "string",
      "street": "string",
      "building": "string",
      "literal_yomi": "string"
    },
    "resident_card_address_head_of_family": "string",
    "resident_card_address_relation_name": "string",
    "position": "string",
    "positions": [
      {
        "id": "string",
        "name": "string",
        "rank": 0,
        "code": "string",
        "created_at": "2025-06-13T02:58:01.166Z"
      }
    ],
    "grade": {
      "id": "string",
      "name": "string",
      "rank": 0,
      "created_at": "2025-06-13T02:58:01.166Z",
      "updated_at": "2025-06-13T02:58:01.166Z"
    },
    "job_category": {
      "id": "string",
      "name": "string",
      "created_at": "2025-06-13T02:58:01.166Z",
      "updated_at": "2025-06-13T02:58:01.166Z"
    },
    "occupation": "string",
    "entered_at": "2025-06-13",
    "resigned_at": "2025-06-13",
    "resigned_reason": "string",
    "resume1": {
      "file_name": "string",
      "url": "string"
    },
    "resume2": {
      "file_name": "string",
      "url": "string"
    },
    "emp_ins_insured_person_number": "string",
    "emp_ins_insured_person_number_image": {
      "file_name": "string",
      "url": "string"
    },
    "emp_ins_insured_person_number_unknown_reason_type": "no_work_experience",
    "emp_ins_qualified_at": "2025-06-13",
    "emp_ins_disqualified_at": "2025-06-13",
    "previous_workplace": "string",
    "previous_employment_start_on": "2025-06-13",
    "previous_employment_end_on": "2025-06-13",
    "soc_ins_insured_person_number": 0,
    "hel_ins_insured_person_number": 0,
    "basic_pension_number": "string",
    "basic_pension_number_image": {
      "file_name": "string",
      "url": "string"
    },
    "first_enrolling_in_emp_pns_ins_flag": true,
    "basic_pension_number_unknown_reason_type": "non_pensionable",
    "first_workplace": "string",
    "first_workplace_address_text": "string",
    "first_employment_start_on": "2025-06-13",
    "first_employment_end_on": "2025-06-13",
    "last_workplace": "string",
    "last_workplace_address_text": "string",
    "last_employment_start_on": "2025-06-13",
    "last_employment_end_on": "2025-06-13",
    "soc_ins_qualified_at": "2025-06-13",
    "soc_ins_disqualified_at": "2025-06-13",
    "having_spouse": true,
    "spouse_yearly_income": 0,
    "monthly_income_currency": 0,
    "monthly_income_goods": 0,
    "payment_period": {
      "id": "string",
      "name": "string",
      "period_type": "monthly",
      "updated_at": "2025-06-13T02:58:01.166Z",
      "created_at": "2025-06-13T02:58:01.166Z"
    },
    "monthly_base_salary": 0,
    "monthly_standard_income_updated_at": "2025-06-13",
    "monthly_standard_income_hel": 0,
    "monthly_standard_income_pns": 0,
    "nearest_station_and_line": "string",
    "commutation_1_expenses": 0,
    "commutation_1_period": "commutation_period_1_month",
    "commutation_1_single_fare": 0,
    "commutation_2_expenses": 0,
    "commutation_2_period": "commutation_period_1_month",
    "commutation_2_single_fare": 0,
    "foreign_resident_last_name": "string",
    "foreign_resident_first_name": "string",
    "foreign_resident_middle_name": "string",
    "foreign_resident_card_number": "string",
    "foreign_resident_card_image1": {
      "file_name": "string",
      "url": "string"
    },
    "foreign_resident_card_image2": {
      "file_name": "string",
      "url": "string"
    },
    "nationality_code": "string",
    "resident_status_type": "string",
    "resident_status_other_reason": "string",
    "resident_end_at": "2025-06-13",
    "having_ex_activity_permission": "permitted",
    "other_be_workable_type": "other_be_workable",
    "bank_accounts": [
      {
        "bank_code": "string",
        "bank_branch_code": "string",
        "account_type": "saving",
        "account_number": "string",
        "account_holder_name": "string",
        "bankbook_image": {
          "file_name": "string",
          "content": "string"
        },
        "bank_account_setting_id": "string"
      }
    ],
    "department": "string",
    "departments": [
      {
        "id": "string",
        "name": "string",
        "full_name": "string",
        "position": 0,
        "code": "string",
        "parent": "string",
        "children": [
          "string"
        ],
        "updated_at": "2025-06-13T02:58:01.166Z",
        "created_at": "2025-06-13T02:58:01.166Z"
      }
    ],
    "contract_type": "unlimited",
    "contract_start_on": "2025-06-13",
    "contract_end_on": "2025-06-13",
    "contract_renewal_type": "renewal",
    "tax_cd": "kou",
    "handicapped_type": "ordinary_handicapped",
    "handicapped_note_type": "string",
    "handicapped_note_delivery_at": "2025-06-13",
    "handicapped_image": {
      "file_name": "string",
      "url": "string"
    },
    "working_student_flag": true,
    "school_name": "string",
    "student_card_image": {
      "file_name": "string",
      "url": "string"
    },
    "enrolled_at": "2025-06-13",
    "working_student_income": 0,
    "employment_income_flag": true,
    "business_income_flag": true,
    "devidend_income_flag": true,
    "estate_income_flag": true,
    "widow_type": "widow",
    "widow_reason_type": "divorce",
    "widow_memo": "string",
    "custom_fields": [
      {
        "value": "string",
        "template": {
          "id": "string",
          "name": "string",
          "type": "date",
          "elements": [
            {
              "id": "string",
              "name": "string",
              "physical_name": "string",
              "position": 0
            }
          ],
          "group_id": "string",
          "group": {
            "id": "string",
            "name": "string",
            "position": 0,
            "access_type": "read_and_update",
            "templates": [
              "string"
            ],
            "updated_at": "2025-06-13T02:58:01.166Z",
            "created_at": "2025-06-13T02:58:01.166Z"
          },
          "hint": "string",
          "scale": 0,
          "separated_by_commas": true,
          "position": 0,
          "updated_at": "2025-06-13T02:58:01.166Z",
          "created_at": "2025-06-13T02:58:01.166Z"
        }
      }
    ],
    "created_at": "2025-06-13T02:58:01.166Z",
    "updated_at": "2025-06-13T02:58:01.166Z"
  }
}

送信の制御

API リクエスト時に以下のパラメータを付与すると、そのリクエストによるデータ更新では Webhook が送信されなくなります。
skip_sending_webhook=true