employee.health_insurance.policy.expired

Payload

1 {
2   "id": "string",
3   "type": "string",
4   "platform_id": "string",
5   "data": {
6     "id": "string",
7     "employer_id": "string",
8     "employee_id": "string",
9     "start_date": "string",
10     "end_date": "string",
11     "status": "scheduled",
12     "enrolment_type": "opt_out",
13     "renewal": {
14       "status": "upcoming",
15       "renewal_date": "string",
16       "window_start_date": "string",
17       "window_end_date": "string",
18       "decision_confirmed": true,
19       "renewed_health_insurance_id": "string"
20     },
21     "opt_out_deadline_date": "string",
22     "coverage_level": {
23       "plan_id": "string",
24       "plan_name": "string",
25       "plan_currency": "eur",
26       "provider_name": "string",
27       "provider_logo_url": "string",
28       "documents": [
29         {
30           "title": "string",
31           "link": "string"
32         }
33       ],
34       "provider_employer_platform_url": "string",
35       "provider_support_phone": "string"
36     },
37     "object": "string",
38     "external_customer_id": "string",
39     "cancellation_date": "string",
40     "policy_number": "string"
41   },
42   "created_at": "string",
43   "api_version": "string",
44   "object": "string"
45 }

Payload

The payload of this webhook request is an object.

idstringOptionalformat: "evt_*"

typestringOptional

platform_idstringOptionalformat: "pt_*"

dataobjectOptional

created_atstringOptionalformat: "date-time"

api_versionstringOptional

objectstringOptional

Response

200

any

Return a 200 status to indicate that the data was received successfully.