For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get access
Getting Started Key Concepts Integration Types Core Components Embed Hosted API API Reference
  • API Reference
    • Contribution Reports
    • Events and Webhooks
      • GETList all events
      • GETRetrieve an event
      • GETList all webhook endpoints
      • GETRetrieve a webhook endpoint
      • Working with webhooks
        • POSTemployee.created
        • POSTemployee.updated
        • POSTemployee.offboarded
        • POSTemployer.created
        • POSTemployer.updated
        • POSTemployer.offboarded
        • POSTemployer.health_insurance.quote.created
        • POSTemployer.health_insurance.quote.action_required
        • POSTemployer.health_insurance.quote.not_undertaken
        • POSTemployer.health_insurance.quote.accepted
        • POSTemployer.health_insurance.quote.pending_quote
        • POSTemployer.health_insurance.quote.pending_insurer_acceptance
        • POSTemployee.health_insurance.offer.action_required
        • POSTemployee.health_insurance.policy.activated
        • POSTemployee.health_insurance.policy.cancelled
        • POSTemployee.health_insurance.policy.expired
        • POSTcontribution_report.finalized
    • API Errors
Get access
LogoLogo
API ReferenceEvents and WebhooksTypes of Events

employee.health_insurance.policy.activated

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": "string",
24      "plan_currency": "eur",
25      "provider_name": "string",
26      "provider_logo_url": "string",
27      "documents": [
28        {
29          "title": "string",
30          "link": "string"
31        }
32      ]
33    },
34    "enrolled_dependants_count": 123,
35    "estimated_gross_premium": {
36      "currency": "eur",
37      "monthly": {
38        "employee_contribution": 123.45,
39        "employer_contribution": 123.45,
40        "total": 123.45
41      },
42      "term": {
43        "employee_contribution": 123.45,
44        "employer_contribution": 123.45,
45        "total": 123.45
46      }
47    }
48  },
49  "created_at": "2024-12-01T00:00:00Z",
50  "object": "event",
51  "api_version": "1.0"
52}
Previous

employee.health_insurance.offer.action_required

Next

employee.health_insurance.policy.cancelled

Built with

Payload

The payload of this webhook request is an object.
idstringRequiredformat: "evt_*"
typestringRequired
platform_idstringRequiredformat: "pt_*"
dataobjectRequired
created_atdatetimeRequired
objectstringRequired
api_versionstringRequired

Response

2XX
Your server implementation should return this HTTP status code if the data was received successfully
4XX
If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
5XX

If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!