Event Types

Event Payload Envelope

All events arrive as an HTTP POST with a JSON array containing a single event object.

[
  {
    "topic": "your-integration-stream",
    "subject": "/api/Employees/98765",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "eventType": "employeeAdded",
    "eventTime": "2026-04-13T14:30:00Z",
    "dataVersion": "1.0",
    "metadataVersion": "1",
    "data": {
      "employeeId": 98765,
      "companyId": 1001
    }
  }
]

Field	Type	Description
`id`	`string` (UUID)	Unique identifier for this event instance — use for deduplication
`eventType`	`string`	The type of event (see below)
`eventTime`	`string` (ISO 8601 UTC)	When the event occurred
`subject`	`string`	Relative path to the affected resource in the Netchex External API (e.g. `/api/Employees/98765`)
`topic`	`string`	Identifier for your integration's event stream
`data`	`object`	Event-specific fields — see tables below
`dataVersion`	`string`	Schema version of the event data
`metadataVersion`	`string`	Schema version of the event metadata

Use subject or the IDs inside data to fetch full resource details from the Netchex External API. Do not rely solely on the event payload — it contains only identifiers, not authoritative resource data.

Employee

Event Type	`data` Fields
`employeeAdded`	`employeeId` (int64), `companyId` (int32)
`employeeUpdated`	`employeeId` (int64), `companyId` (int32)
`employeeTerminated`	`employeeId` (int64), `companyId` (int32)
`employeeEnrollmentCompleted`	`employeeId` (int64), `companyId` (int32)

Employee Dependents

Event Type	`data` Fields
`employeeDependentAdded`	`dependentId` (int64), `employeeId` (int64), `companyId` (int32)
`employeeDependentUpdated`	`dependentId` (int64), `employeeId` (int64), `companyId` (int32)

Benefits

Event Type	`data` Fields
`employeeBenefitEnrolled`	`employeeBenefitId` (int64), `employeeId` (int64), `companyId` (int32)
`employeeBenefitUpdated`	`employeeBenefitId` (int64), `employeeId` (int64), `companyId` (int32)
`employeeBenefitCoverageEnded`	`employeeBenefitId` (int64), `employeeId` (int64), `companyId` (int32)

Payroll

Event Type	`data` Fields
`payrollStarted`	`companyId` (int32), `payrollId` (int32), `paySchedules` (array)
`payrollSubmitted`	`companyId` (int32), `payrollNumber` (int32)
`payrollConfirmed`	`companyId` (int32), `payrollId` (int32)
`payrollYearRolloverStarted`	`companyId` (int32)
`carryoverStarted`	`companyId` (int32), `paySchedules` (array)
`companyPayrollInvoiced`	`payrollId` (int32), `companyId` (int32)

The event types available to your integration depend on your agreement with Netchex. Contact your integration representative if you need access to types not currently in your subscription.