Back

ADP Workforce Now API Essential Guide

Aug 3, 20246 minute read

What type of API does ADP Workforce Now provide?

ADP Workforce Now uses RESTful APIs for its integration capabilities. Here are the key points:

API Type

ADP Workforce Now utilizes RESTful APIs for its integration needs. RESTful APIs enable users to perform commands and exchange information between two channels using specific endpoints.

Application Types

ADP Workforce Now offers two types of applications in the ADP Marketplace, both of which use RESTful APIs:

  1. Data Connector: This type doesn't require end-user involvement in the workflow. It's used for syncing data across internal systems or updating data on a scheduled basis.

  2. End User Application: This type requires end-user identity and authorization to initiate any flow. It's used when retrieving data on behalf of an end-user from an external customer application.

Key APIs

Two popular APIs offered by ADP Workforce Now are:

  1. Workers v2 API: Used to generate a full list of all workers in an organization and retrieve worker-related data.

  2. Pay data input v1 API: Used to send batch API calls to request pay data for a payroll cycle.

Considerations

  • Both application types (Data Connector and End User Application) are considered RESTful APIs.
  • ADP's API marketplace provides a comprehensive suite of building blocks for developers to create integrations.
  • The APIs allow for seamless retrieval and return of payroll and other HR-related data requests to designated endpoints.

In summary, ADP Workforce Now primarily uses RESTful APIs for its integration capabilities, offering different application types and specific APIs for various HR and payroll functions.

Does the ADP Workforce Now API have webhooks?

Based on the search results provided, here's the relevant information about webhooks in the official ADP Workforce Now API:

Direct Answer

The search results do not provide any explicit information about webhooks in the official ADP Workforce Now API. There is no clear indication that the official API supports webhooks or what events you can subscribe to.

Key Points to Consider

  1. The search results primarily focus on the Worker Hire Event API and other related APIs for ADP Workforce Now, but do not mention webhooks.

  2. There is mention of a "New event via webhook" in [2], but this appears to be related to a third-party integration platform (Workato) rather than the official ADP API.

  3. The official ADP Developer Resources [4] are mentioned, but no specific information about webhooks is provided.

  4. The Worker Hire Event API guide [5] discusses various API endpoints and events, but does not mention webhooks.

Best Practices

  1. To get accurate and up-to-date information about the official ADP Workforce Now API's capabilities, including webhooks, it's best to consult the official ADP API documentation or contact ADP support directly.

  2. If webhooks are not available in the official API, consider exploring alternative integration methods such as polling or scheduled API calls to retrieve updates.

  3. Third-party integration platforms like Workato (mentioned in [2]) may offer webhook functionality for ADP Workforce Now, but these are not part of the official API and may have limitations or additional costs.

In conclusion, based on the provided search results, there is no clear evidence that the official ADP Workforce Now API supports webhooks. For the most accurate information, it's recommended to consult the official ADP documentation or contact their support team directly.

Rate Limits and other limitations

Based on the search results provided, here are the key points about the API Rate Limits of the ADP Workforce Now API:

Rate Limiting

  1. The ADP Marketplace Web API Gateway uses two types of rate limiting: Rate Limiting and Concurrency [1].

  2. Rate limiting controls the total number of calls to API endpoints per second or per minute [1].

  3. The rate limits are applied to each integration profile and enforced per subscribed client [1].

  4. When the rate limit is exceeded, a 429 error will be returned [1].

Concurrency Limiting

  1. Concurrency limiting restricts the number of open API calls or transactions through the gateway at any given time [1].

  2. It is enforced per subscribed client per associated integration profile [1].

  3. If the concurrency limit is reached, a 429 error will be returned [1].

Current Production Limits

The current production limits are applied across four nodes and vary based on tiers [1]:

  1. Default Tier:

    • Rate: 300 calls/min
    • Concurrency: 50 calls
  2. Tier 2:

    • Rate: 480 calls/min
    • Concurrency: 50 calls
  3. Tier 3:

    • Rate: 780 calls/min
    • Concurrency: 50 calls

Single Node Limits

It's important to note that there are also limits per single node [1]:

  1. Default Tier:

    • Rate: 75 calls/min
    • Concurrency: 12 calls
  2. Tier 2:

    • Rate: 120 calls/min
    • Concurrency: 12 calls
  3. Tier 3:

    • Rate: 195 calls/min
    • Concurrency: 12 calls

Key Considerations

  1. If you reach either of the limits on a single node, you may receive a 429 response [1].

  2. The most common cause for a 429 response is violating the single node concurrency limit [1].

  3. For example, if you have 12 open connections on the same node, the 13th call would result in a 429 response if none of the 12 open connections closed before the new call was opened [1].

It's crucial to design your application to handle these rate limits and potential 429 responses appropriately to ensure smooth integration with the ADP Workforce Now API.

Latest API Version

Here are the key points regarding the most recent version of the ADP Workforce Now API:

  1. The most recent version mentioned in the search results is the Applicant Onboard V2 API for ADP Workforce Now Next Gen [2].

  2. Key details about this API version:

    • It was published on May 10, 2021 and last modified on Feb 16, 2022 [2].

    • It supports onboarding new hires into ADP Workforce Now [2].

    • It works with ADP Workforce Now Next Gen [2].

  3. Other related APIs mentioned:

    • Job Applications V2 API, which retrieves job application details [5].

    • Job Applicant External Screening Status Change API, used to change screening status of job applicants [5].

  4. The documentation notes that "All U.S. ADP Workforce Now Next Gen are on the most current version of the Applicant Onboard V2 API." [2]

  5. There are no specific version numbers mentioned, but the "V2" in the API names suggests these are second versions of these APIs.

It's important to note that while these appear to be the most recent versions based on the provided information, API versions can change frequently. For the most up-to-date information, it would be best to check ADP's official developer documentation or contact their developer support directly.

How to get a ADP Workforce Now developer account and API Keys?

To get a developer account for ADP Workforce Now and create an API integration, you need to follow these steps:

1. Create an ADP Developer Account

The first step is to create an ADP Developer account:

  • Visit the ADP Developer Portal [1].
  • Sign up for a free account if you don't already have one [1].

2. Register a Developer App

Once you have an ADP Developer account, you can register a new developer app:

  • Log in to your ADP Developer account.
  • Navigate to the app registration section.
  • Fill in the required information for your app, including:
    • App name
    • Description
    • Callback URL
  • Agree to the ADP Developer Terms of Service and Privacy Policy.
  • Click the "Submit" button to complete the app registration process [1].

3. Obtain App Credentials

After registering your app, you can get your app credentials:

  • Click on the "Credentials" tab in your app's dashboard.
  • You will find your app's Client ID and Client Secret, which are used to authenticate your app and access the ADP APIs [1].

Key Points to Consider

  1. Make sure your redirect_uri is set to https://api.unified.to/oauth/code if you plan to use Unified.to with these credentials [1].

  2. Keep your Client ID and Client Secret secure, as they are used to authenticate your app.

  3. Familiarize yourself with ADP's API documentation and best practices for integration.

Best Practices

  1. Use a secure method to store your app credentials.

  2. Implement proper error handling and rate limiting in your integration.

  3. Consider using a service like Unified.to to simplify the integration process, especially if you're planning to integrate with multiple services or platforms [1].

  4. Stay updated with any changes or updates to ADP's API documentation and terms of service.

By following these steps, you can obtain a developer account for ADP Workforce Now and create an API integration. Remember to review ADP's documentation thoroughly and follow their guidelines for API usage and best practices.

[1] https://unified.to/blog/how_to_register_an_adp_developer_app_and_get_oauth2_credentials

What can you do with the ADP Workforce Now API?

Based on the information provided in the search results, here's a list of data models you can interact with using the ADP Workforce Now API, along with what is possible for each:

Employee Data

  • Synchronize employee job titles, email addresses, and demographic data between systems
  • Read and update employee information

Time and Attendance

  • Read and update timecards and work schedules
  • Note: This feature is not available for ADP Workforce Now Next Generation
  • Read, update, and submit time-off requests
  • Access and manage time-off balances

Payroll

  • Add pay-data batches for a payroll cycle
  • Include earnings, deductions, reimbursements, and more in payroll input

Onboarding

  • Onboard new hires into ADP
  • Automate user provisioning between systems when new hires are onboarded

Recruiting

  • Read job and applicant data

Additional Capabilities

  • Synchronize data between ADP and other systems, such as:
    • HR systems
    • Finance systems
    • IT ecosystems
    • Applicant Tracking Systems (ATSs)
    • Enterprise Resource Planning (ERP) systems
    • Learning Management Systems (LMSs)
    • Ticketing systems
    • Payroll services
    • Identity directories

Key Points to Consider

  • The API uses OpenID Connect and OAuth 2.0 for authentication and authorization
  • Developers can access a comprehensive developer portal at developers.adp.com for API documentation, code samples, and more
  • ADP offers packaged API use cases for common integration scenarios
  • Integration services are available through ADP Marketplace partners for those without in-house developer resources

It's important to note that the specific APIs available may vary depending on your ADP Workforce Now subscription and the version you're using. Always refer to the most up-to-date documentation on the ADP developer portal for the most accurate and comprehensive list of available APIs and their capabilities.