ADP WorkForce Now Element Docs

The ADP WorkForce Now element is available in the humancapital hub.

On this page:

Authentication Prerequisites

The ADP WorkForce Now element uses a custom authentication workflow. Before you can provision an instance of the ADP WorkForce Now element, you need the following:

Provider sandbox

An ADP WorkForce Now account and sandbox are provided by ADP.

Custom credentials

Following are the mandatory fields to authenticate with the ADP WorkForce Now element:

  • API key
  • API Secret
  • Base64 Encoded JKS 
  • JKS Password 

But the ADP element requires a few extra steps to authenticate. To locate credentials for your ADP WorkForce Now account:

  1. You will receive credentials including an SSL Certificate and SSL Certificate Private Key from ADP through an email.
  2. Using the SSL Certificate file and the SSL Certificate Private Key files, follow the steps mentioned here to create a Base64 Encoded JavaKeystore and a JKS password for use with the ADP element.
  3. The API key and API secret will be provided to you by ADP through an email.

Enter these credentials to authenticate with the element.

Required Authentication Parameters

You can authenticate the ADP Workforce Now element instance using the UI or via API calls. For detailed information on how to authenticate an instance, see our related documentation:

To authenticate an instance of the ADP Workforce Now element, you will need the following parameters:

Parameter Name/UI ValueAPI ValueDescriptionSource
OAuth API Keyoauth.api.keyProvided by ADPCustom Credentials
OAuth API Secretoauth.api.secretProvided by ADPCustom Credentials
Base64 Encoded JKSbase64.encoded.jksGenerated before authenticationElement Builder - Elements TLS v1.2/Two-Way SSL
JKS Passwordjks.passwordGenerated before authenticationElement Builder - Elements TLS v1.2/Two-Way SSL
OAuth Callback URLoauth.callback.urlDefault value is an Element Instance (API)

Sample Configuration JSON

"configuration": {
    "oauth.api.key": "myApiKey",
    "oauth.api.secret": "[myApiSecret]",
    "base64.encoded.jks": "[myBase64Encodedjks]",
    "jks.password": "[myjkspassword]",
    "oauth.callback.url": ""

Element Fact Sheet and Reference

Authentication and Configuration Parameters

To see all authentication parameters for the ADP Workforce Now element, follow these steps:

  1. Sign in to Cloud Elements and navigate to Elements.
  2. Hover over the card for an element, and then click My Resources. 
  3. In the top navigation toolbar, click Setup.
  4. From the Setup page, you can view a complete list of the element's authentication and configuration parameters.

Events and Supported Resources

The ADP Workforce Now element supports events via polling. For detailed information about our Events framework and how to configure an element instance with events, see our documentation:

You can set up events via polling for the employees resource of the ADP Workforce Now element.

Queryable Endpoints

You can use CEQL to query the following endpoints of the ADP Workforce Now element:

  • GET /bulk/jobs
  • GET /employees
  • GET /{objectName}
  • GET /{objectName}/{objectId}/{childObjectName}

API Documentation

The base URL for all API requests is

Provider Documentation