ADP Workforce Now Connector

ADP Workforce Now is a human capital management (HCM) platform. This component allows you to manage applicants, workers, and payroll data within ADP Workforce Now.

API Documentation

This component was built using the ADP Workforce Now API Reference.

Connections

ADP Workforce Now OAuth 2.0

This connection allows you to authenticate with ADP Workforce Now using OAuth 2.0.

To connect to ADP Workforce Now using OAuth 2.0, several credentials and certificate files are required. ADP's OAuth implementation uses client certificates for enhanced security in addition to standard OAuth credentials.

For detailed information about ADP's OAuth implementation, refer to the ADP Developer Documentation.

Prerequisites

• An active ADP Workforce Now account
• Access to the Developer Self Service Portal
• Contact with an ADP client representative to obtain initial credentials
• Ability to generate SSL certificate signing requests (CSR)

Setup Steps

1. Contact the ADP client representative to request access to the Developer Self Service Portal if not already available.

2. Log in to the Developer Self Service Portal.

3. Create a new project to house the OAuth credentials:

   • Navigate to the projects section
   • Click Create Project
   • Enter the project name and details
   • Save the project

4. Navigate to the Development Credentials tab within the project to locate the Client ID and Client Secret values. Copy these values for later use.

5. Configure the OAuth callback URL:

   • Switch from the Data Connector tab to the End-user/SSO tab
   • In the App redirect URI field, enter: https://oauth2.integrations.acme.com/callback
   • Save the configuration

6. Generate and configure SSL certificates:

   • Follow the Certificate Signing Request Guide to generate a certificate signing request
   • Submit the CSR to ADP through the Developer Portal
   • Download the Certificate File (.pem) and Key File once approved
   • Keep these files secure as they will be needed for the connection configuration

Configure the Connection

After obtaining all required credentials and certificates, configure the connection in the integration:

Field	Description
API Endpoint	The ADP API endpoint URL. Select api.adp.com for production or uat-api.adp.com for testing/UAT environments.
Token Endpoint	The token endpoint URL. Select accounts.adp.com for production or uat-accounts.adp.com for UAT environments.
Client ID	The Client ID from the Development Credentials tab in the Developer Portal.
Client Secret	The Client Secret from the Development Credentials tab in the Developer Portal.
Key File	The entire contents of the private key file (.key) generated from the certificate signing request.
Certificate File	The entire contents of the certificate file (.pem) received after the CSR was approved.
Subscriber Organization OID	(Optional) The organization OID of the subscribed client. Only required when querying data from an organization different from the one associated with the Client ID and Client Secret.

Input	Comments	Default
API Endpoint	The endpoint to use for the ADP Workforce Now API.	https://api.adp.com/
Token Endpoint	The OAuth 2.0 token endpoint URL for ADP authentication.	https://accounts.adp.com/auth/oauth/v2/token
Client ID	The client ID for the project in the ADP Developer Portal
Client Secret	The client secret for the project in the ADP Developer Portal
Key File	The key file generated from the ADP Developer Portal
Certificate File	The certificate file (.pem) generated from the ADP Developer Portal
Subscriber Organization OID	The organization OID (OOID) of the subscribed client. Only specify this if using a client ID and client secret for an organization different from the one being queried.

Actions

Add Personal Contact

Adds a worker’s personal contact

Input	Comments	Default
Associate OID	The unique Associate OID identifier of the worker.
Personal Contact	The personal contact data structure. View data dictionary for all available fields.
Connection	The ADP Workforce Now connection to use.

Create Scan/Punch

Performs a scan punch operation where the first scan represents an “IN” punch and the next scan represents an “OUT” punch.

Input	Comments	Default
Badge ID	The badge identifier associated with the time punch being recorded.
Clocking Type	The type of time punch operation. Punch mode alternates between IN and OUT on each scan.	punch
Connection	The ADP Workforce Now connection to use.

Delete Personal Contact

Removes a worker’s personal contact.

Input	Comments	Default
Associate OID	The unique Associate OID identifier of the worker.
Personal Contact ID	The ID of the personal contact to delete.
Connection	The ADP Workforce Now connection to use.

Get Applicant Onboard Metadata

Retrieve a single asset

Input	Comments	Default
Context Templates	The geopolitical context template for the onboarding process.	US
Filter	Specifies an expression that an item must match to be included in a response. Various criteria could be combined using and/or operands and () to set the operand precedence. e.g. /mobileUserAccounts/associateOID eq 'G4O73G9Z62SL2NFM'
Connection	The ADP Workforce Now connection to use.

Get Clocking Transaction

Returns the status of a previously submitted clocking transaction such as “Clock-In”, “Clock-Out,” “Scan”, etc.

Input	Comments	Default
Event ID	The unique identifier of the clocking transaction event.
Connection	The ADP Workforce Now connection to use.

Get Personal Contact

Returns a personal contact

Input	Comments	Default
Associate OID	The unique Associate OID identifier of the worker.
Personal Contact ID	The ID of the personal contact to retrieve.
Select	Comma-separated list of properties to include in the response using OData property paths.
Connection	The ADP Workforce Now connection to use.

Get Personal Contact Meta

Returns a personal contact metadata

Input	Comments	Default
Associate OID	The unique Associate OID identifier of the worker.
Select	Comma-separated list of properties to include in the response using OData property paths.
Connection	The ADP Workforce Now connection to use.

Get Time Cards

Get a worker's team's timecards. That is all the time cards for the worker's team members. The worker is identified by workers/[aoid]

Input	Comments	Default
Associate OID	The unique Associate OID identifier of the worker.
Skip	The number of items to skip from the beginning of the list for pagination.
Top	The maximum number of items to return in the response.
Filter	Specifies an expression that an item must match to be included in a response. Various criteria could be combined using and/or operands and () to set the operand precedence. e.g. /mobileUserAccounts/associateOID eq 'G4O73G9Z62SL2NFM'
Expand	The related resources to include inline in the response using OData expand syntax.
Connection	The ADP Workforce Now connection to use.
Debug Request	Enabling this flag will log out the current request.	false

Get Worker

Retrieve a worker by their Associate OID

Input	Comments	Default
Associate OID	The unique Associate OID identifier of the worker.
Select	Comma-separated list of properties to include in the response using OData property paths.
Connection	The ADP Workforce Now connection to use.

Get Worker Demographics

Returns a worker demographic by Associate OID

Input	Comments	Default
Associate OID	The unique Associate OID identifier of the worker.
Select	Comma-separated list of properties to include in the response using OData property paths.
Connection	The ADP Workforce Now connection to use.

Get Worker Metadata

Retrieves a meta on workers

Input	Comments	Default
Filter	Specifies an expression that an item must match to be included in a response. Various criteria could be combined using and/or operands and () to set the operand precedence. e.g. /mobileUserAccounts/associateOID eq 'G4O73G9Z62SL2NFM'
Connection	The ADP Workforce Now connection to use.

Get Worker Payment Distributions

Returns a worker's pay distribution records

Input	Comments	Default
Associate OID	The unique Associate OID identifier of the worker.
Select	Comma-separated list of properties to include in the response using OData property paths.
Filter	Specifies an expression that an item must match to be included in a response. Various criteria could be combined using and/or operands and () to set the operand precedence. e.g. /mobileUserAccounts/associateOID eq 'G4O73G9Z62SL2NFM'
Connection	The ADP Workforce Now connection to use.

Get Worker Payment Distributions Meta

Returns a worker's pay distribution records metadata

Input	Comments	Default
Select	Comma-separated list of properties to include in the response using OData property paths.
Connection	The ADP Workforce Now connection to use.

List Company Codes

Returns a list of company codes

Input	Comments	Default
Filter	Specifies an expression that an item must match to be included in a response. Various criteria could be combined using and/or operands and () to set the operand precedence. e.g. /mobileUserAccounts/associateOID eq 'G4O73G9Z62SL2NFM'
Connection	The ADP Workforce Now connection to use.

List Personal Contacts

Returns a list of a worker’s personal contacts.

Input	Comments	Default
Associate OID	The unique Associate OID identifier of the worker.
Select	Comma-separated list of properties to include in the response using OData property paths.
Connection	The ADP Workforce Now connection to use.

List Worker Demographics

Request the list of all available worker demographics that the requester is authorized to view.

Input	Comments	Default
Fetch All	When true, fetches all records using pagination and ignores parameters like $skip and $top.	false
Skip	The number of items to skip from the beginning of the list for pagination.
Top	The maximum number of items to return in the response.
Filter	Specifies an expression that an item must match to be included in a response. Various criteria could be combined using and/or operands and () to set the operand precedence. e.g. /mobileUserAccounts/associateOID eq 'G4O73G9Z62SL2NFM'
Select	Comma-separated list of properties to include in the response using OData property paths.
Query Parameters	The query parameters that will be appended to the URL. The parameters should be in key-value pairs.
Connection	The ADP Workforce Now connection to use.
Debug Request	Enabling this flag will log out the current request.	false

List Workers

Retrieves all available workers that the requester is authorized to view.

Input	Comments	Default
Fetch All	When true, fetches all records using pagination and ignores parameters like $skip and $top.	false
Skip	The number of items to skip from the beginning of the list for pagination.
Top	The maximum number of items to return in the response.
Count	The OData $count parameter MUST be used to specify the total number criterion. This parameter can't be used with $top or $skip.
Filter	Specifies an expression that an item must match to be included in a response. Various criteria could be combined using and/or operands and () to set the operand precedence. e.g. /mobileUserAccounts/associateOID eq 'G4O73G9Z62SL2NFM'
Select	Comma-separated list of properties to include in the response using OData property paths.
Query Parameters	The query parameters that will be appended to the URL. The parameters should be in key-value pairs.
Connection	The ADP Workforce Now connection to use.
Debug Request	Enabling this flag will log out the current request.	false

Modify Time Entries

Modify time entries event instance

Input	Comments	Default
Events	The new time entries to be added, modified or deleted. Please refer to the API documentation for the structure of the time entries. https://developers.adp.com/build/api-explorer/hcm-offrg-wfn/hcm-offrg-wfn-time-time-cards-v2-time-cards?operation=POST%2Fevents%2Ftime%2Fv2%2Ftime-entries.modify
Connection	The ADP Workforce Now connection to use.

Post Applicant Onboard Process

Manage data related to the applicant onboarding request.

Input	Comments	Default
Applicant Onboarding	The applicant onboarding data, the example payload has a the structure of a minimal onboarding inprogress payload for a US Client applicant. Please refer to the docs to see examples from other countries and full list of fields
Connection	The ADP Workforce Now connection to use.

Raw Request

Send raw HTTP request to the ADP Workforce Now API

Input	Comments	Default
URL	Input the path only (/hr/v2/workers). The base URL is already included (https://api.adp.com/). For example, to connect to https://api.adp.com/hr/v2/workers, only /hr/v2/workers is entered in this field.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Debug Request	Enable this to log the request and response	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false
Connection	The ADP Workforce Now connection to use.

Update Personal Contact

Updates an existing worker’s personal contact

Input	Comments	Default
Associate OID	The unique Associate OID identifier of the worker.
Personal Contact ID	The unique identifier of the personal contact to update.
Personal Contact	The personal contact data structure. View data dictionary for all available fields.
Connection	The ADP Workforce Now connection to use.

Update Worker Pay Distribution

Replaces an employee's existing Direct Deposit records with an updated collection

Input	Comments	Default
Associate OID	The unique Associate OID identifier of the worker.
Work Assignment ID	The unique identifier of the worker's work assignment for pay distribution updates.
Payment Distribution	The payment distribution data structure for direct deposit configuration.
Connection	The ADP Workforce Now connection to use.