v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Types of events

employee.created

postWebhookEmployeeCreatedWebhook

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.created",
  "platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "data": {
    "platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
    "id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
    "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
    "date_of_birth": "2024-12-01",
    "start_on": "2024-12-01",
    "earliest_benefits_start_date": "2024-12-01",
    "offboard_on": "2024-12-01T00:00:00Z"
  },
  "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