Use Case: Synchronizing a Worker Using Event Notifications

Before You Begin

See All You Need to Know about Processing Notification Messages for ADP Workforce Now.

Use Case Description

ADP applications trigger notifications when data is updated, and your application subscribes notifications to sync-up data. For more information about ADP notifications, see ADP Event APIs and Event Notification Guide.

Supported Notifications

The tables in the following sections list all supported notifications. The following describes how the tables are set-up:

  • Table title describes the navigation path to the ADP Workforce Now screen.
  • Field Name – Indicates the name of the field.
  • Application Scope – Lists the canonical ID to be added to your application.
  • GitHub Sample Payload – Lists the file name and location where you could find sample payload on ADP's GITHUB repository.

People > Personal Information > Personal Profile > Name

ADP Workforce Now Field Name

Application Scope

First Name

/hr/workerInformationManagement/workerManagement/associateManagement/worker.legalName.change.eventNotify.subscribe

Last Name

/hr/workerInformationManagement/workerManagement/associateManagement/worker.legalName.change.eventNotify.subscribe

Preferred Name

/hr/workerInformationManagement/workerManagement/associateManagement/worker.legalName.change.eventNotify.subscribe

Maiden Name

/hr/workerInformationManagement/workerManagement/associateManagement/worker.birthname.change.eventNotify.subscribe

People > Employment > Employment Profile > Regular Pay

ADP Workforce Now Field Name

Application Scope

Regular Pay Rate

/hr/workerInformationManagement/workerManagement/workAssignmentManagement/worker.workAssignment.baseRemuneration.change.eventNotify.subscribe

Rate 2 - 9

/hr/workerInformationManagement/workAssignmentManagement/workAssignmentManagement/worker.workAssignment.additionalRemuneration.add.eventNotify.subscribe

 

/hr/workerInformationManagement/workAssignmentManagement/workAssignmentManagement/worker.workAssignment.additionalRemuneration.change.eventNotify.subscribe

Rate 2 – 9

/hr/workerInformationManagement/workAssignmentManagement/workAssignmentManagement/worker.workAssignment.additionalRemuneration.remove.eventNotify.subscribe

Standard Hours

/hr/workerInformationManagement/workAssignmentManagement/workAssignmentManagement/worker.workAssignment.standardHours.change.eventNotify.subscribe

People > Personal Information > Personal Profile > Addresses

The following table includes the primary or secondary address.

ADP Workforce Now Field Name

Application Scope

GitHub Sample Response Payload

 

Legal Address

/hr/workerInformationManagement/workerManagement/addressManagement/worker.legalAddress.add.eventNotify.subscribe

legal-address-add-event-notification-http-200-response.json
 

Legal Address

/hr/workerInformationManagement/workerManagement/addressManagement/worker.legalAddress.change.eventNotify.subscribe

legal-address-change-event-notification-http-200-response.json
 

Legal Address

/hr/workerInformationManagement/workerManagement/addressManagement/worker.legalAddress.remove.eventNotify.subscribe

legal-address-remove-event-notification-http-200-response.json
 

Non-Legal Address

/hr/workerInformationManagement/workerManagement/addressManagement/worker.personalAddress.add.eventNotify.subscribe

personal-address-add-event-notification-http-200-response.json
 

Non-Legal Address

/hr/workerInformationManagement/workerManagement/addressManagement/worker.personalAddress.change.eventNotify.subscribe

personal-address-change-event-notification-http-200-response.json
 

Non-Legal Address

/hr/workerInformationManagement/workerManagement/addressManagement/worker.personalAddress.remove.eventNotify.subscribe

personal-address-remove-event-notification-http-200-response.json
 

People > Personal Information > Personal Profile > Contact

ADP Workforce Now Field Name

Application Scope

GitHub Sample Response Payload

Home Phone

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.landline.add.eventNotify.subscribe

Get personal communication landline add Response

Home Phone

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.landline.change.eventNotify.subscribe

Get personal communication landline change Response

Home Phone

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.landline.remove.eventNotify.subscribe

Get personal communication landline remove Response

Personal Fax

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.fax.add.eventNotify.subscribe

Get personal communication fax add Response

Personal Fax

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.fax.change.eventNotify.subscribe

Get personal communication fax change Response

Personal Fax

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.fax.remove.eventNotify.subscribe

Get personal communication fax remove Response

Personal Pager

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.pager.add.eventNotify.subscribe

Get personal communication pager add Response

Personal Pager

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.pager.change.eventNotify.subscribe

Get personal communication pager change Response

Personal Pager

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.pager.remove.eventNotify.subscribe

Get personal communication pager remove Response

Personal Mobile

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.mobile.add.eventNotify.subscribe

Get personal communication mobile add Response

Personal Mobile

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.mobile.change.eventNotify.subscribe

Get personal communication mobile change Response

Personal Mobile

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.mobile.remove.eventNotify.subscribe

Get personal communication mobile remove Response

Personal E-mail

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.email.add.eventNotify.subscribe

Get personal communication email add Response

Personal E-mail

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.email.change.eventNotify.subscribe

Get personal communication email change Response

Personal E-mail

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.personalCommunication.email.remove.eventNotify.subscribe

 

Work Phone

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.landline.add.eventNotify.subscribe

Get Business Communication landline add Response

Work Phone

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.landline.change.eventNotify.subscribe

Get Business Communication landline change Response 

Work Phone

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.landline.remove.eventNotify.subscribe

Get Business Communication landline remove Response

Work Fax

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.fax.add.eventNotify.subscribe

Get Business Communication fax add Response

Work Fax

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.fax.change.eventNotify.subscribe

Get Business Communication fax change Response

Work Fax

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.fax.remove.eventNotify.subscribe

Get Business Communication fax remove Response

Work Cell

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.mobile.add.eventNotify.subscribe

Get Business Communication mobile add Response

Work Cell

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.mobile.change.eventNotify.subscribe

Get Business Communication mobile change Response

Work Cell

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.mobile.remove.eventNotify.subscribe

Get Business Communication mobile remove Response

Work Pager

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.pager.add.eventNotify.subscribe

 

Work Pager

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.pager.change.eventNotify.subscribe

 

Work Pager

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.pager.remove.eventNotify.subscribe

 

Work E-mail

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.email.add.eventNotify.subscribe

Get Business Communication email add Response

Work E-mail

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.email.change.eventNotify.subscribe

Get Business Communication email change Response

Work E-mail

/hr/workerInformationManagement/workerManagement/communicationManagement/worker.businessCommunication.email.remove.eventNotify.subscribe

 

People > Personal Information > Personal Profile > Demographics

ADP Workforce Now Field Name

Application Scope

Birth Date

/hr/workerInformationManagement/workerManagement/associateManagement/worker.birthdate.change.eventNotify.subscribe

Educational Level

/hr/workerInformationManagement/workerManagement/associateManagement/worker.highestEducationLevel.change.eventNotify.subscribe

Ethnicity

/hr/workerInformationManagement/workerManagement/associateManagement/worker.ethnicity.change.eventNotify.subscribe

Race

/hr/workerInformationManagement/workerManagement/associateManagement/worker.race.change.eventNotify.subscribe

Gender

/hr/workerInformationManagement/workerManagement/associateManagement/worker.gender.change.eventNotify.subscribe

Marital Status

/hr/workerInformationManagement/workerManagement/associateManagement/worker.maritalStatus.change.eventNotify.subscribe

Religion

/hr.workerInformationManagement.workerManagement.associateManagement.worker.religion.change.eventNotify.subscribe

Highest Education Level

/hr/workerInformationManagement/workerManagement/associateManagement/worker.highestEducationLevel.change.eventNotify.subscribe

People > Personal Information > Statutory Compliance > Protected Veteran

ADP Workforce Now Field Name

Application Scope

[Protected Veteran Status]

/hr/workerInformationManagement/workerManagement/associateManagement/worker.militaryStatus.change.eventNotify.subscribe

[Protected Veteran Classification]

/hr/workerInformationManagement/workerManagement/associateManagement/worker.militaryClassification.change.eventNotify.subscribe

People > Employment > Employment Profile > Custom Fields

ADP Workforce Now Field Name

Application Scope

GitHub Sample Response Payload

Employment Custom Fields

/hr/workerInformationManagement/workerManagement/customFieldManagement/worker.customField.amount.change.eventNotify.subscribe

 

Employment Custom Fields

/hr/workerInformationManagement/workerManagement/customFieldManagement/ worker.customField.code.change.eventNotify.subscribe

custom-field-code-change-event-notification-http-200-response.json

Employment Custom Fields

/hr/workerInformationManagement/workerManagement/customFieldManagement/ worker.customField.date.change.eventNotify.subscribe

custom-field-date-change-event-notification-http-200-response.json

Employment Custom Fields

/hr/workerInformationManagement/workerManagement/customFieldManagement/worker.customField.indicator.change.eventNotify.subscribe

custom-field-indicator-change-event-notification-http-200-response.json

Employment Custom Fields

/hr/workerInformationManagement/workerManagement/customFieldManagement/worker.customField.percentage.change.eventNotify.subscribe

custom-field-percent-change-event-notification-http-200-response.json

Employment Custom Fields

/hr/workerInformationManagement/workerManagement/customFieldManagement/worker.customField.string.change.eventNotify.subscribe

custom-field-string-change-event-notification-http-200-response.json

Employment Custom Fields

/hr/workerInformationManagement/workerManagement/customFieldManagement/worker.customField.telephone.change.eventNotify.subscribe

 

Process > HR

ADP Workforce Now Field Name

Application Scope

GitHub Sample Response Payload

Hire

/hr/workerInformationManagement/workerManagement/lifecycleManagement/worker.hire.eventNotify.subscribe

worker-hire-event-notification-http-200-response.json

Place on Leave

/hr/workerInformationManagement/workerManagement/lifecycleManagement/worker.onLeave.eventNotify.subscribe

 

Rehire

/hr/workerInformationManagement/workerManagement/lifecycleManagement/worker.rehire.eventNotify.subscribe

HR-worker-rehire-event-200-response.json

Terminate

/hr/workerInformationManagement/workerManagement/lifecycleManagement/worker.terminate.eventNotify.subscribe

worker.terminate-event-notification-http-200-response.json

Original Hire Date

/hr/workerInformationManagement/workerDateManagement/originalHireDateManagement/worker.workerOriginalHireDate.change.eventNotify.subscribe

 

People > Employment > Employment Profile > Position

ADP Workforce Now Field Name

Application Scope

GitHub Sample response payload

Reports To

/hr/workerInformationManagement/workerManagement/workRelationshipManagement/ worker.reportsTo.modify.eventNotify.subscribe reportsTo-modify-event-notification-http-200-response.json
 
Position ID /hr/workerInformationManagement/workerManagement/ workAssignmentManagement/ worker.workAssignment.modify.eventNotify.subscribe  
FLSA

/hr/workerInformationManagement/workerManagement/workAssignmentManagement/worker.workAssignment.modify.eventNotify.subscribe


Tip:

An event can be generated only when a change is made in ADP Workforce Now and not through the API.

 
Worker Category /hr/workerInformationManagement/workAssignmentManagement/workerTypeManagement/ worker.workAssignment.workerType.change.eventNotify.subscribe HR-workerType-Category-200-res

People > Pay > Pay Profile > Other Pay Settings

ADP Workforce Now Field Name

Application Scope

Check Controls > Pay Group

/hr/workerInformationManagement/workerManagement/workAssignmentManagement/worker.workAssignment.modify.eventNotify.subscribe

 

Tip:

An event can be generated only when a change is made in ADP Workforce Now and not through the API.

People > Employment > Employment Profile > Corporate Groups

ADP Workforce Now Field Name

Application Scope

Home Department

/hr/workerInformationManagement/workerManagement/workAssignmentManagement/worker.workAssignment.homeOrganizationalUnits.modify.eventNotify.subscribe

 

Tip:

An event can be generated only when a change is made in ADP Workforce Now and not through the API.

Home Cost Number /hr/workerInformationManagement/workerManagement/workAssignmentManagement/worker.workAssignment.homeOrganizationalUnits.modify.eventNotify.subscribe
Business Unit /hr/workerInformationManagement/workerManagement/workAssignmentManagement/worker.workAssignment.homeOrganizationalUnits.modify.eventNotify.subscribe
Location /hr/workerInformationManagement/workAssignmentManagement/workAssignmentManagement/worker.workAssignment.homeWorkLocation.change.eventNotify.subscribe