DocumentationAPI Reference
API Reference
Start typing to search…

Employee Updated

wbhk
employee.updated

Triggered when an employee record is updated and at least one of the monitored fields has changed.

Behavior & Constraints

  • Monitoring: At least one monitorField is required when subscribing to this event via POST /api/v1/webhooks.
  • Permissions: For API-created webhooks, this event will not fire if the webhook creator lacks access to all monitored fields being changed.

Detailed Description

  • Creation Sequence: When an employee is created, both employee.created and employee.updated events fire sequentially due to the create-then-initialize pattern.
  • Field Consolidation: When multiple fields change simultaneously, they may be consolidated into a single event. Currently, custom field updates and standard field updates are grouped separately and may fire as two events.
  • Effective Dates: For history-tracked fields (e.g., jobTitle, payRate), events fire only when changes take effect, not when future-dated changes are created.
  • Changed Fields: The changedFields array contains the API aliases for fields that changed and are monitored by this webhook. Aliases match those returned by GET /api/v1/webhooks/monitor_fields.

Deprecation Notice

Note: This event is the modern replacement for the legacy employee_with_fields.updated event. While the legacy event is deprecated, it will remain available for the foreseeable future to support existing integrations. We encourage using this new event for all new development.

Important: You cannot subscribe to both this new event and the legacy employee_with_fields events on the same webhook. Webhooks created without specifying any events will default to the legacy behavior, effectively subscribing to the employee_with_fields events automatically.