employee.health_insurance.policy.activated

Payload

The payload of this webhook request is an object.
idstringOptionalformat: "evt_*"
typestringOptional
platform_idstringOptionalformat: "pt_*"
dataobjectOptional
created_atdatetimeOptional
api_versionstringOptional
objectstringOptional

Response

200
any
Return a 200 status to indicate that the data was received successfully.
Payload
1{
2 "id": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3 "type": "employee.health_insurance.policy.activated",
4 "platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
5 "data": {
6 "id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
7 "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
8 "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
9 "start_date": "2024-12-01",
10 "end_date": "2024-12-01",
11 "status": "scheduled",
12 "enrolment_type": "opt_out",
13 "renewal": {
14 "status": "upcoming",
15 "renewal_date": "2024-12-01",
16 "window_start_date": "2024-12-01",
17 "window_end_date": "2024-12-01",
18 "decision_confirmed": true
19 },
20 "opt_out_deadline_date": "2024-12-01",
21 "coverage_level": {
22 "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
23 "plan_name": "plan_name",
24 "plan_currency": "eur",
25 "provider_name": "provider_name",
26 "provider_logo_url": "provider_logo_url",
27 "documents": [
28 {
29 "title": "title",
30 "link": "link"
31 }
32 ]
33 }
34 },
35 "api_version": "1.0",
36 "object": "event"
37}
Built with