Skip to main content

UKG Pro HCM Recruitment & Onboarding

Access UKG Pro Recruiting & Onboarding to manage job opportunities, candidates, applications, and offers via OAuth2.

What you can ask​

  • List all open job opportunities and show how many applications each has received.
  • Find candidates in the final interview stage who haven't received an offer yet.
  • Pull all new hires currently in onboarding and check their completion status.

Set up​

UKG Pro HCM Recruitment & Onboarding needs an OAuth application from your organization before anyone can connect. An organization admin completes these steps once.

  1. Go to Organization > Connectors and find UKG Pro HCM Recruitment & Onboarding. Click Enable, and choose which tools to allow.
  2. Create an OAuth application in the UKG Pro HCM Recruitment & Onboarding developer portal.
  3. Add the Redirect URI shown in the connector settings to the application.
  4. Copy the application's Client ID and Client Secret into the connector, then save it.
  5. Each member connects their own account the first time they use it.

⚠️ Warning: Do not enter your Devs.ai or UKG Pro HCM Recruitment & Onboarding login email or password in the OAuth application fields.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

OAuth scopes used by these tools (6)

Grant the scopes for the tools you plan to allow.

  • recruiting.domain.application-import.create
  • recruiting.domain.application-import.read
  • recruiting.domain.candidate-import.create
  • recruiting.domain.candidate-import.read
  • recruiting.domain.configuration.read
  • recruiting_api

Tools​

UKG Pro HCM Recruitment & Onboarding offers 25 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (15)​

View and search information without changing it.

ToolWhat it does
get_applicationGet a single application by ID from UKG Pro Recruiting.
get_candidateGet a single candidate by ID from UKG Pro Recruiting.
get_new_hireGet a single new hire record by ID from UKG Pro Onboarding.
get_offerGet a single job offer by ID from UKG Pro Recruiting.
get_opportunityGet a single job opportunity by ID from UKG Pro Recruiting.
get_recruiting_processGet a single recruiting process template by ID from UKG Pro Recruiting.
list_applicationsList candidate applications in UKG Pro Recruiting with pagination.
list_candidatesList candidates in UKG Pro Recruiting with pagination.
list_new_hires_completedList completed new hires in UKG Pro Onboarding.
list_new_hires_in_progressList new hires currently in progress in UKG Pro Onboarding.
list_offersList job offers in UKG Pro Recruiting with pagination.
list_opportunitiesList job opportunities (open requisitions) in UKG Pro Recruiting with pagination.
list_recruiting_processesList recruiting process templates in UKG Pro Recruiting.
lookup_candidateLook up a candidate by email address in UKG Pro Recruiting.
validate_credentialValidate UKG Pro Recruiting credentials by obtaining an OAuth2 token and calling the recruiting processes endpoint.

Write (5)​

Create or send data.

ToolWhat it does
create_applicationSubmit a candidate application for a job opportunity in UKG Pro Recruiting.
create_candidateCreate a new candidate in UKG Pro Recruiting.
create_new_hireCreate a new hire record in UKG Pro Onboarding to start the onboarding process.
create_offerCreate a job offer for an applicant in UKG Pro Recruiting.
create_opportunityCreate a new job opportunity (job posting/requisition) in UKG Pro Recruiting.

Delete or overwrite (5)​

Remove or replace existing data.

ToolWhat it does
delete_new_hireDelete (cancel) a new hire record in UKG Pro Onboarding.
update_applicationUpdate the status or stage of an application in UKG Pro Recruiting.
update_candidateUpdate an existing candidate's profile in UKG Pro Recruiting.
update_offerUpdate a job offer in UKG Pro Recruiting (e.g. accept, decline, or rescind).
update_opportunityUpdate an existing job opportunity in UKG Pro Recruiting.
⌘J