v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Types of events

employee.health_insurance.policy.expired

postWebhookEmployeeHealthInsurancePolicyExpiredWebhook

Payload

idstring required
typestring required
platform_idstring required
created_atstring date-time required
objectstring required
api_versionstring required

Example payload

{
  "id": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "type": "employee.health_insurance.policy.expired",
  "platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "data": {
    "id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
    "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
    "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
    "start_date": "2024-12-01",
    "end_date": "2024-12-01",
    "cancellation_date": "2024-12-01",
    "renewal": {
      "renewal_date": "2024-12-01",
      "window_start_date": "2024-12-01",
      "window_end_date": "2024-12-01",
      "decision_confirmed": true,
      "renewed_health_insurance_id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a"
    },
    "opt_out_deadline_date": "2024-12-01",
    "coverage_level": {
      "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a"
    },
    "enrolled_dependants_count": 123,
    "estimated_gross_premium": {
      "monthly": {
        "employee_contribution": 123.45,
        "employer_contribution": 123.45,
        "total": 123.45
      },
      "term": {
        "employee_contribution": 123.45,
        "employer_contribution": 123.45,
        "total": 123.45
      }
    }
  },
  "created_at": "2024-12-01T00:00:00Z",
  "object": "event",
  "api_version": "1.0"
}

Response

Your server implementation should return this HTTP status code if the data was received successfully