Back

UKG Pro Recruiting API Essential Guide

Aug 11, 20246 minute read

What type of API does UKG Pro Recruiting provide?

REST API

  • UKG Pro offers REST-based web services as part of its API.
  • The UKG Pro API enables integration via REST-based web services.
  • UKG Pro recruiting REST APIs require an Authorization Token to authenticate.
  • There are REST API specifications available for UKG Pro.

SOAP API

  • UKG Pro also offers SOAP-based web services as part of its API.
  • The technical specifications mention support for Simple Object Access Protocol (SOAP) 1.2.
  • There are SOAP Services tutorials available for UKG Pro.

Key Points

  • UKG Pro supports both REST and SOAP APIs for integration.
  • The REST APIs use JSON or XML.
  • Authentication for REST APIs uses Authorization Tokens.
  • SOAP APIs use SOAP 1.2 protocol.
  • There is documentation available for both REST and SOAP APIs.

Does the UKG Pro Recruiting API have webhooks?

Webhooks in UKG Pro

Yes, the official UKG Pro system does have webhooks functionality, called UKG Webhooks. However, the information provided does not specifically mention the Recruiting API having webhooks.

Types of Events

UKG Webhooks allows users to subscribe to a catalog of events. While the search results don't provide an exhaustive list of event types specifically for recruiting, they do mention that users can subscribe to various events. The events are associated with subscriptions and are displayed in an Events grid, showing the event's status, timestamp, and name.

Key Points to Consider

  1. Event Subscription: Users can subscribe to specific events and implement Hash-Based Message Authentication Codes (HMAC) to ensure the security of the messages.

  2. Real-time Notifications: When an event is triggered in the UKG Pro solution, the UKG Webhooks application enables passing that event's information to an endpoint of your choosing in near real-time.

  3. Subscription Management: Subscriptions can be tested, deactivated, and reactivated at any time.

  4. Event Details: To view the information contained in an event's payload, users can select the event in the Events grid.

  5. Role-Based Access: UKG Webhooks incorporates Role-Based Access Control (RBAC) with three primary roles: Admin, Editor, and Viewer.

Best Practices

  1. Security: When configuring a subscription, consider entering a Hash-based Message Authentication Code (HMAC) secret for Webhook message verification.

  2. Testing: Test your subscription's endpoint to ensure notifications can be received.

  3. Monitoring: Regularly check the Events grid to view the status of events and their payloads.

  4. Backup Plan: If creating a business-critical integration based on UKG Webhooks notifications, consider implementing a secondary polling synchronization or nightly report as a safeguard.

While the search results don't provide specific information about the Recruiting API's webhook capabilities, they do confirm that UKG Pro has a robust webhooks system. For detailed information about available events for the Recruiting API, you may need to consult the UKG Webhooks Events Catalog or contact UKG support directly.

Rate Limits and other limitations

Here are the key points about the API Rate Limits for the UKG Pro Recruiting API:

API Rate Limiting

  • UKG Pro employs an API gateway to manage quotas and rate limits for API calls.

  • The rate limit is typically set for how many API calls a client can make in a 1 minute period.

  • If the rate of requests is too high, the server will return an HTTP 429 status code.

  • Receiving a 429 is not an error, but a request to reduce the rate of API calls.

  • Applications must respect the server's rate limits and not try to circumvent them.

Handling Rate Limits

  • UKG is considering implementing a "Retry-after" header with 429 responses in the future.

  • Until then, clients should use a default delay of 1 second before retrying after receiving a 429.

  • Optionally, clients can use an exponentially increasing delay when retrying.

Best Practices

  • Respect the server's rate limits and do not try to bypass them.

  • Implement proper handling of 429 responses in your application.

  • Use a delay/backoff strategy when retrying after hitting rate limits.

  • Monitor your API usage to stay within the allowed limits.

The exact numeric rate limits are not specified in the provided documentation. Developers should be prepared to handle 429 responses and implement appropriate retry logic in their applications when integrating with the UKG Pro Recruiting API.

Latest API Version

Based on the search results provided, here are the key points regarding the most recent version of the UKG Pro Recruiting API:

Latest Version

The most recent version of the UKG Pro Recruiting API appears to be part of the Pro 2024.R1 release [1][2].

Key Points

  1. A full suite of Recruiting API resources and operations, over 100 in total, was added in the Pro 2024.R1 release [2].

  2. The new Recruiting content can be found in the Pro API specification [2].

  3. The Pro 2024.R1 APIs became available approximately 4 months ago from the current date [1][2].

  4. UKG Pro APIs now use REST-based web services, allowing for retrieval and updating of UKG Pro data [3].

  5. Authentication for the UKG Pro Recruiting API requires an Authorization Token, unlike the core REST APIs which use Basic Authentication [3].

Additional Information

  • The UKG Pro API enables integration of UKG Pro data for various use cases, from API dashboards to data replication and custom reporting front-ends [3].

  • Historical REST API operation information can be found by viewing the Version History in the API documentation [3].

  • UKG has also introduced UKG Webhooks, which allow subscribing to specific events and implementing Hash-Based Message Authentication Codes (HMAC) for message security [2].

  • The API specifications now allow inputting appropriate authorization values needed to call the API, making it easier to create example API requests [2].

To get the most up-to-date and detailed information about the UKG Pro Recruiting API, it's recommended to check the official UKG Pro API documentation and release notes, as API versions and features may have been updated since the last major release.

How to get a UKG Pro Recruiting developer account and API Keys?

To get a developer account for UKG Pro Recruiting and create an API integration, you'll need to follow these steps:

1. Contact UKG Pro Support

The first step is to reach out to UKG Pro support or your account representative to request access to their developer program. UKG Pro does not have a self-service developer portal, so you'll need to work directly with them to set up your developer account.

2. Obtain Necessary Credentials

Once your developer account is approved, you'll need to obtain the following credentials:

  • UKG Client ID and Secret: These can be obtained by contacting UKG Pro directly.
  • UKG Tenant Name: This is typically found in the URL when you log into UKG Pro Recruiting. It's the second part of the URL after "ultipro.com".
  • UKG Subdomain: This can be found in your UKG Pro portal under System Configuration > Security > Web Services.
  • UKG API Key: This can be found in your UKG Pro account under Service Account Administration.

3. Set Up Authentication

UKG Pro uses OAuth 2.0 for API authentication. You'll need to use your Client ID and Secret to obtain an access token for API requests.

4. Explore API Documentation

Once you have access, you can explore the UKG Pro API documentation:

  • The UKG Developer Hub: This is your main resource for comprehensive documentation, code samples, and tutorials.
  • REST API v2: This is the modern, developer-friendly interface for accessing UKG Pro data.
  • UKG Pro Web Services API Guide: This guide details SOAP-based web services for specific functionalities.

5. Start Developing

With your credentials and access to the documentation, you can start developing your integration. Remember to:

  • Be mindful of API versioning when integrating with your systems.
  • Leverage the UKG Developer Hub forum and communities for support and best practices.

What can you do with the UKG Pro Recruiting API?

Based on the search results provided, here is a list of data models that can be interacted with using the UKG Pro Recruiting API, along with what is possible for each:

Recruiting API Resources

  • The UKG Pro API has recently added a full suite of Recruiting API resources and operations, with over 100 in total [3]. Here are some key data models and capabilities:

    • Applicant Tracking

      • Manage candidates through the hiring process
      • Utilize powerful search tools to find candidates
      • Configure workflows to map hiring processes to business needs [4]
    • Job Postings

      • Create and manage job postings
      • Likely ability to retrieve, update, and delete job postings
    • Candidates

      • Store and retrieve candidate information
      • Track candidates through various stages of the hiring process
      • Possibly update candidate statuses and information
    • Applications

      • Manage applications submitted by candidates
      • Likely ability to retrieve application details and update statuses
    • Interviews

      • Schedule and manage interviews
      • Possibly retrieve interview details and update outcomes
    • Offers

      • Create and manage job offers
      • Likely ability to retrieve offer details and update statuses
    • Onboarding

      • Initiate and track the onboarding process for new hires
      • Seamlessly integrate with HR and payroll systems [4]

Key Capabilities

  • Recruitment Marketing

    • Enhance employer brand through API-enabled recruitment marketing tools [4]
  • Analytics and Reporting

    • Access customizable hiring dashboards
    • Retrieve metrics like time-to-fill for positions [4]
  • Integration

    • Seamlessly integrate recruiting data with other UKG Pro modules like core HR and payroll [4]
  • Automation

    • Leverage AI-powered features to automate tasks like resume screening [4]

Additional Considerations

  • The API likely supports standard CRUD (Create, Read, Update, Delete) operations for most recruiting-related data models
  • Authentication is required using UKG Pro credentials and API keys [3]
  • The API documentation in the UKG Pro Developer Hub provides detailed information on available resources and operations [3]

It's important to note that while these capabilities are likely available through the API, the exact details and extent of operations for each data model would need to be confirmed in the official API documentation.