Documentation
What's NewUKG.comMarketplaceUKG Pro status

UKG Webhooks Events Catalog

This document describes each of the various events to which users can subscribe using UKG Webhooks as well as how each event is triggered.

UKG Webhooks allows users to subscribe to the following catalog of events.

Note: For more information about UKG Webhooks, refer to the UKG Webhooks User Guide.

In UKG Webhooks, events are associated with a subscription and are displayed in the Events grid. The grid displays the event's status, timestamp, and name. To view the information contained in an event's payload, select the event. The event's payload appears in the Event Payload section.

Event Payload Format

The payload sent by each event to the designated endpoint URL resembles the following example:

{
  "EventId": 459469162,
  "EventTime": "2024-04-16T15:51:52.64",
  "EventType": "EmployeeAddressChangeEvent",
  "Operation": "Update",
  "Payload": {
    "CoId": "UWLN6",
    "EeId": "4W7QK90000K0",
    "IntegrationRecordId": null
  },
  "Tenant": "G0311"
}

Employee Person Name Change Event

Event Type

"EventType": "EmployeePersonNameChangeEvent"

Changes to the following Person Name fields in UKG Pro can trigger the Employee Person Name Change Event:

  • Prefix
  • First Name
  • Middle Name
  • Last Name
  • Suffix
  • Preferred First Name
  • Former Last Name

Additionally, the following actions trigger an Employee Person Name Change Event:

  • Inserts – The PersonName record for an EE will be inserted upon new hire:

    • Web > Add Employee Wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire Process
    • Back Office > New Hire process
    • Back Office > Import Process

  • Updates – Updates to the PersonName table can happen by leveraging:

    • Web > Change Name, Address, Telephone business process
    • Web > Web Import Tool > Change Name, Address, Telephone business process
    • Back Office > Manually update EE record
    • Back Office > Import process

  • Deletes – Deletes to the PersonName table can occur if the EE is deleted from UKG Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Date of Birth Change Event

Event Type

"EventType": "EmployeeDateOfBirthChangeEvent"

Changes to the following fields in UKG Pro can trigger the Employee Date of Birth Change Event:

  • Date of Birth

Additionally, the following actions trigger an Employee Date of Birth Change Event:

  • Inserts – The DOB for an EE will be inserted upon new hire:

    • Web > Add Employee wizardWeb > Add US/Canadian/International Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the DOB can happen by leveraging::

    • Web > Change Private Info business process
    • Web > Web Import Tool > Change Private Info business process
    • Back Office > Manually update EE record
    • Back Office > Import process

  • Deletes – Deletes to the DOB can occur if the EE is deleted from Pro.

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Date Deceased Change Event

Event Type

"EventType": "EmployeeDateDeceasedChangeEvent"

Changes to the following fields in UKG Pro can trigger the Employee Date Deceased Change Event:

  • Deceased

Additionally, the following actions trigger an Employee Date Deceased Change Event:

  • Inserts – The Date Deceased for an EE can be inserted, updated, or deleted by leveraging:

    • Web > Change Status and Key Dates business process
    • Web > Web Import Tool > Change Status and Key Dates business process
    • Back Office > Manually update EE record

  • Deletes – Deletes can occur if the EE is deleted from the system:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Disability Change Event

Event Type

"EventType": "EmployeeDisabilityChangeEvent"

Changes to the following fields in UKG Pro can trigger the Employee Disability Change Event:

  • Disabled
  • Disability Type

Additionally, the following actions trigger an Employee Disability Change Event:

  • Inserts or Updates – The Disability Status can be inserted or updated by leveraging:

    • Web > Change Private Info business process
    • Web > Web Import Tool > Change Private Info business process
    • Back Office > Manually Update EE Record

  • Deletes – Deletes to employee disability can occur if the EE is deleted from Pro.

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Gender Change Event

Event Type

"EventType": "EmployeeGenderChangeEvent"

Matches the activities of Employee Date of Birth Change Event.

Employee Marital Status Change Event

Event Type

"EventType": "EmployeeMaritalStatusChangeEvent"

Matches the activities of Employee Date of Birth Change Event.

Employee Address Change Event

Event Type

"EventType": "EmployeeAddressChangeEvent"

Matches the activities of Employee Person Name Change Event.

Employee Email Change Event

Event Type

"EventType": "EmployeeEmailChangeEvent"

Matches the activities of Employee Person Name Change Event.

Employee Phone Change Event

Event Type

"EventType": "EmployeePhoneChangeEvent"

The following actions trigger an Employee Phone Change Event:

  • Inserts – The Phone data for an EE will be inserted upon new hire:

    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the Phone data can happen by leveraging:

    • Web > Change Name, Address, Telephone Business Process
    • Web > Add/Change Alternate Phone Number
    • Web > Web Import Tool > Change Name, Address, Telephone business process
    • Web > Web Import Tool > Add/Change Alternate Phone Number
    • Back Office > Manually update EE record
    • Back Office > Import process

  • Deletes – Deletes to the Phone data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Job Change Event

Event Type

"EventType": "JobChangeEvent"

The following actions trigger an Employee Job Change Event:

  • Inserts – The JobChange data for an EE will be inserted upon new hire:

    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the JobChange data can happen by leveraging:

    • Web > Change Job
    • Web > Change Job and Salary
    • Web > Change Salary
    • Web > Change Organization
    • Web > Web Import Tool > Change Job and Salary business process
    • Web > Mass Update Tool
    • Back Office > Manually update EE record
    • Back Office > Import processs

  • Deletes – Deletes to the JobChange data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Type Change Event

Event Type

"EventType": "EmployeeTypeChangeEvent"

Matches the activities of Employee Job Change Event.

Employment Status Change Event

Event Type

"EventType": "EmploymentStatusChangeEvent"

The following actions trigger an Employment Status Change Event:

  • Updates – Updates to the StatusChange data can happen by leveraging:

    • Web > Change Status and Key Dates
    • Web > Employee Transfer
    • Web > Termination
    • Web > Rehire or Multi Company Hire
    • Web > Web Import Tool > Change Status and Key Dates business process
    • Web > Performing any web import that affects EE Status (New Hire, Rehire, MultiCo Hire, Transfer, Termination)
    • Back Office > Manually update EE record

  • Deletes – Deletes to the StatusChange data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Hire Date Change Event

Event Type

"EventType": "EmployeeHireDateChangeEvent"

The following actions trigger an Employee Hire Date Change Event:

  • Updates – Updates to the HireDate data can happen by leveraging:

    • Web > Change Status and Key Dates
    • Web > Web Import Tool > Change Status and Key Dates business process
    • Back Office > Manually update EE record

  • Deletes – Deletes to the HireDate data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Date Of Benefits Seniority Change Event

Event Type

"EventType": "EmployeeDateOfBenefitsSeniorityChangeEvent"

Matches the activities of Employee Hire Date Change Event.

Employee Number Change Event

Event Type

"EventType": "EmployeeNumberChangeEvent"

The following actions trigger an Employee Number Date Change Event:

  • Inserts – The EmployeeNumber data for an EE will be inserted upon new hire:

    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the EmployeeNumber data can happen by leveraging:

    • Web > Change Employee Number
    • Back Office > Manually update EE record

  • Deletes – Deletes to the EmployeeNumber data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Termination Change Event

Event Type

"EventType": "EmployeeTerminationChangeEvent"

The following actions trigger an Employee Termination Change Event:

  • Inserts – The Termination data for an EE will be inserted upon new hire:

    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the Termination data can happen by leveraging:

    • Web > Change Employee Number
    • Back Office > Manually update EE record

  • Deletes – Deletes to the Termination data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employment Date Last Worked Change Event

Event Type

"EventType": "EmploymentDateLastWorkedChangeEvent"

Matches the activities of Employee Termination Change Event.

Employee Project Change Event

Event Type

"EventType": "EmployeeProjectChangeEvent"

The following actions trigger an Employee Project Change Event:

  • Inserts – The Project data for an EE can be instered upon a new hire, and if not, can be done by performing a job change:

    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Web > Change Job
    • Web > Change Job and Salary
    • Web > Change Organization
    • Web > Web Import Tool > Change Job and Salary business process
    • Web > Mass Update Tool
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the Project data can happen by leveraging:

    • Web > Change Job
    • Web > Change Job and Salary
    • Web > Change Organization
    • Web > Web Import Tool > Change Job and Salary business process
    • Web > Mass Update Tool
    • Back Office > Manually update EE record
    • Back Office > Import process

  • Deletes – Deletes to the Project data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Supervisor Change Event

Event Type

"EventType": "EmployeeSupervisorUpdated"

The following actions trigger an Employee Supervisor Change Event:

  • Inserts – The Supervisor data for an EE can be inserted upon a new hire, and if not, can be done by performing a job change:

    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Web > Change Job
    • Web > Change Job and Salary
    • Web > Change Organization
    • Web > Web Import Tool > Change Job and Salary business process
    • Web > Mass Update Tool
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the Project data can happen by leveraging:

    • Web > Change Job
    • Web > Change Job and Salary
    • Web > Change Organization
    • Web > Web Import Tool > Change Job and Salary business process
    • Web > Mass Update Tool
    • Web > Reassign Direct Reports
    • Back Office > Manually update EE record
    • Back Office > Import process

  • Deletes – Deletes to the Project data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employment Union Change Event

Event Type

"EventType": "EmployeeUnionChangeEvent"

Matches the activities of Employee Project Change Event.

Employee Hourly Pay Rate Change Event

Event Type

"EventType": "EmployeeHourlyPayRateChangeEvent"

The following actions trigger an Employee Hourly Pay Rate Change Event:

  • Inserts – The HourlyPayRate data for an EE will be inserted:

    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Web > Web Import Tool > Change Job and Salary business process
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the HourlyPayRate data can happen by leveraging:

    • Web > Change Job
    • Web > Change Job and Salary
    • Web > Web Import Tool > Change Job and Salary business process
    • Web > Mass Update Tool
    • Back Office > Manually update EE record
    • Back Office > Import process

Note: There are other actions that can be taken in Pro that adversely affect the EEs hourly pay rate. Quick examples include:

  • Changing an EEs scheduled work hours can recalculate their pay rate.

  • If you have the Compensation Management module and issue pay rate changes via Salary Plan.

  • Deletes – Deletes to the HourlyPayRate data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employment Org Level Change Event

Event Type

"EventType": "EmployeeOrgLevelUpdated"

Matches the activities of Employee Project Change Event.

Employee License Change Event

Event Type

"EventType": "EmployeeLicenseChangeEvent"

The following actions trigger an Employee License Change Event:

  • Inserts, Updates, and Deletes – The LicenseInfo for an EE can be inserted, updated, or deleted by leveraging:
    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Back Office > Manually update EE record

Note: Deletes can also occur if the EE is deleted from the system:

  • Web > Administration > Employee Admin > Employee Management > Delete Employee
  • Back Office > Tools > Utilities > Delete Employee

Employee Skill Change Event

Event Type

"EventType": "EmployeeSkillChangeEvent"

The following actions trigger an Employee Skill Change Event:

  • Inserts, Updates, and Deletes – The SkillInfo for an EE can be inserted, updated, or deleted by leveraging:
    • Web > Add/Change Skill business process
    • Web > Web Import Tool > Add/Change Skill business process
    • Back Office > Manually update EE record

Note: Deletes can also occur if the EE is deleted from the system:

  • Web > Administration > Employee Admin > Employee Management > Delete Employee
  • Back Office > Tools > Utilities > Delete Employee

Employee Education Change Event

Event Type

"EventType": "EmployeeEducationChangeEvent"

The following actions trigger an Employee Education Change Event:

  • Inserts, Updates, and Deletes – The EducationInfo for an EE can be inserted, updated, or deleted by leveraging:
    • Web > Add/Change Education business process
    • Web > Web Import Tool > Add/Change Education business process
    • Back Office > Manually update EE record

Note: Deletes can also occur if the EE is deleted from the system:

  • Web > Administration > Employee Admin > Employee Management > Delete Employee
  • Back Office > Tools > Utilities > Delete Employee

Employee Work Location Change Event

Event Type

"EventType": "EmployeeWorkLocationChangeEvent"

The following actions trigger an Employee Work Location Change Event:

  • Inserts – The WorkLocation data for an EE will be inserted:

    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the WorkLocation data can happen by leveraging:

    • Web > Change Work Location
    • Web > Web Import Tool > Change Work Location
    • Back Office > Manually update EE record

  • Deletes – Deletes to the WorkLocation data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Pay Group Change Event

Event Type

"EventType": "PayGroupChangeEvent"

The following actions trigger an Employee Pay Group Change Event:

  • Inserts – The PayGroup data for an EE will be inserted:

    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the PayGroup data can happen by leveraging:

    • Web > Change Job
    • Web > Change Job and Salary
    • Web > Chang Salary
    • Back Office > Manually update EE record

  • Deletes – Deletes to the PayGroup data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee Pay Period Change Event

Event Type

"EventType": "EmployeePayPeriodChangeEvent"

Matches the activities of Employee Pay Group Change Event.

Employee Deduction Group Change Event

Event Type

"EventType": "EmployeeDeductionGroupChangeEvent"

The following actions trigger an Employee Deduction Group Change Event:

  • Inserts – The DeductionGroup data for an EE will be inserted:

    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the DeductionGroup data can happen by leveraging:

    • Web > Change Job
    • Web > Change Job and Salary
    • Web > Chang Salary
    • Back Office > Manually update EE record

Note: There are other actions that can be taken in Pro that adversely affect the EEs DeductionGroup. A quick example is Open Enrollment & Life Events.

  • Deletes – Deletes to the DedutionGroup data can occur if the EE is deleted from Pro:
    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Employee PTO Change Event

Event Type

"EventType": "PTOChangeEvent"

The following actions trigger an Employee PTO Change Event:

  • Inserts – The PTO data for an EE can be inserted upon new hire, and if not, can be done by performing the following changes:

    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Back Office > New Hire process
    • Back Office > Import process

  • Updates – Updates to the PTO data can happen by leveraging:

    • Web > Add/Change PTO Benefits Plans
    • Web > Web Import Tool > Add/Change PTO Benefit Plans
    • Web > Chang Salary
    • Back Office > Manually update EE record

  • Deletes – Deletes to the PTO data can occur if the EE is deleted from Pro:

    • Web > Administration > Employee Admin > Employee Management > Delete Employee
    • Back Office > Tools > Utilities > Delete Employee

Person Terminated Event

Event Type

"EventType": "PersonTerminatedEvent"

The following actions trigger a Person Terminated Event:

  • Inserts – The Person Termination, can be done by performing the following changes:
    • Web > Terminate Employee wizard
    • Back Office > Employee > Terminate
    • Web > Web Import Tool Termination Process

Person Hired Event

Event Type

"EventType": "PersonHiredEvent"

The following actions trigger a Person Hired Event:

  • Inserts – Person Hired Event, can be done by performing the following changes:
    • Web > Add Employee wizard
    • Web > Add US/Canadian/International Employee wizard
    • Web > Add Global Employee wizard
    • Web > Process Hires
    • Web > Web Import Tool New Hire process
    • Back Office > Employee > New Hire
    • Back Office > Import process

Person Transferred Event

Event Type

"EventType": "PersonTransferredEvent"

The following actions trigger a Person Transferred Event:

  • Inserts – Person Transferred Event, can be done by performing the following changes:
    • Web > Transfer Employee wizard
    • Web > Web Import Tool Employee Transfer Process
    • Back Office > Employee > Company Transfer

Person Rehired Event

Event Type

"EventType": "PersonRehiredEvent"

The following actions trigger a Person Hired Event:

  • Updates – Person Hired Event, can be done by performing the following changes:
    • Web > Add Employee (Hire/Rehire)
      • *When this event is generated, it also generates Person Hired Event.
    • Back Office > Employee > Rehire
    • Web > Web Import Tool Employee Transfer Process
    • Web > Web Import Tool New Hire process

Updated 7 months ago