Connectors

HR & People

UKG Pro Recruiting and Onboarding

Recruiting and onboarding: candidates, opportunities, applications, and new hires
Signs in with
OAuth 2.0 sign-in
Runs on
Cloud or On-Prem Worker
Operations
117
Ready-made triggers
0

Connect UKG Pro Recruiting and Onboarding

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for UKG Pro Recruiting and Onboarding and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
For services offered under Connect a Service you only sign in and approve access. Otherwise use Connect with OAuth2 with your own OAuth app. See Authorize with OAuth.
FieldWhat to enter
API hostRequiredThe Recruiting and Onboarding API host from the UKG Pro Recruiting and Onboarding API Authentication Guide, without https://.
Token endpointRequiredhttps://<host>/signin/oauth2/t/<tenant alias>/access_token, with your tenant alias.Example: https://example.ukg.com/signin/oauth2/t/tenantalias/access_token
Client IDRequiredThe client ID UKG issued through a Customer Success Portal case.
Client secretRequiredSecretThe client secret issued with that client ID.
ScopesOptionalSpace-separated scopes the client was granted, for example recruiting.domain onboarding.

Use it in a flow

  1. Open a flow, open the node library and search for UKG Pro Recruiting and Onboarding.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. Use Test this step to see what it returns, then save.

To start a flow from UKG Pro Recruiting and Onboarding without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if UKG Pro Recruiting and Onboarding can send webhooks, a Webhook trigger receives them at its own URL.

Operations

117 operations in 11 groups. Each one is a step you can add to a flow.

Onboarding: New Hires7
Create a New HirecreateANewHirePOSTCreate a single New Hire.
Delete a New HiredeleteANewHireDELETEDeletes the specified new hire
Get a New HiregetANewHireGETGet a single New Hire by ID
Search Canceled New HiressearchCanceledNewHiresGETSearch New Hires that have had their onboarding process canceled.
Search Completed New HiressearchCompletedNewHiresGETSearch New Hires that have completed their onboarding process and progressed into the Completed status.
Search In-Progress New HiressearchInProgressNewHiresGETSearch New Hires in one of the in-progress statuses.
Updates Platform Configuration Fields on a New HireupdatesPlatformConfigurationFieldsOnANewHirePATCHUpdates one or more Platform Configuration Field values on an existing new hire after creation, including after the new hire has been launched.
Recruiting: Application Disposition Events3
Disposition Application by IDdispositionApplicationByIdPOSTThis operation dispositions an application into a recruiting process step by application ID.
Retrieve Application Disposition EventsretrieveApplicationDispositionEventsGETThis operation returns application disposition events according to the specified query parameters.
Retrieve Application Disposition Events by Application IDretrieveApplicationDispositionEventsByApplicationIdGETThis operation returns disposition events by application ID.
Recruiting: Applications9
Create ApplicationcreateApplicationPOSTThis operation creates a candidate's application and submits that application to UKG Pro Recruiting.
Create Comment by Application IDcreateCommentByApplicationIdPOSTThis operation creates a comment by application ID and adds that comment to the specified application.
Initiate Hire by Application IDinitiateHireByApplicationIdPOSTThis operation initiates a hire for the specified application.
Look Up EasyApply Application by Candidate, Opportunity, and Integration IDlookUpEasyApplyApplicationByCandidateOpportunityAndIntegrationIdPOSTThis operation returns an EasyApply application by Candidate, Opportunity, and Integration ID.
Retrieve Application by IDretrieveApplicationByIdGETThis operation returns an application by ID.
Retrieve ApplicationsretrieveApplicationsGETThis operation returns applications based on the filter criteria passed in the query parameters.
Retrieve Applications by Candidate IDretrieveApplicationsByCandidateIdGETThis operation returns applications by Candidate ID.
Retrieve Comments by Application IDretrieveCommentsByApplicationIdGETThis operation returns comments by application ID Permissions To access this operation, your access token must contain one of the following scopes: recruiting.domain...
Upload Application DocumentuploadApplicationDocumentPOSTThis operation uploads a document and associates it with an application.
Recruiting: Background Checks6
Create Background CheckcreateBackgroundCheckPOSTTo access this operation, your access token must contain one of the following scopes.
Retrieve Background Check By IDretrieveBackgroundCheckByIdGETTo access this operation, your access token must contain one of the following scopes.
Retrieve Background Check Order RequestretrieveBackgroundCheckOrderRequestGETTo access this operation, your access token must contain one of the following scopes.
Retrieve Background Check Results RequestretrieveBackgroundCheckResultsRequestGETTo access this operation, your access token must contain one of the following scopes.
Retrieve Multiple Background ChecksgetTenantApiCandidatesCandidateIdBackgroundChecksGETTo access this operation, your access token must contain one of the following scopes.
Update Background CheckupdateBackgroundCheckPUTTo access this operation, your access token must contain one of the following scopes.
Recruiting: Candidates24
Add Behavior by Candidate IDaddBehaviorbyCandidateIdPOSTThis operation adds a behavior by candidate ID.
Add Comment by Candidate IDaddCommentByCandidateIdPOSTThis operation adds comments by candidate ID.
Add Education by Candidate IDaddEducationByCandidateIdPOSTThis operation adds an education by candidate ID.
Add License by Candidate IDaddLicenseByCandidateIdPOSTThis operation adds a license to a candidate by candidate ID.
Add Motivation by Candidate IDaddMotivationByCandidateIdPOSTThis operations adds a motivation by candidate ID.
Add Reference by Candidate IDaddReferenceByCandidateIdPOSTThis operation adds a reference by candidate ID.
Add Skill by Candidate IDaddSkillByCandidateIdPOSTThis operation adds skills by candidate ID.
Add Work Experience by Candidate IDaddWorkExperienceByCandidateIdPOSTThis operation adds work experience to a candidate by candidate ID.
Create CandidatecreateCandidatePOSTThis operation creates a candidate record in UKG Pro Recruiting.
Retrieve Behaviors by Candidate IDretrieveBehaviorsByCandidateIdGETThis operation returns behaviors by candidate ID.
Retrieve Candidate by EmailretrieveCandidateByEmailPOSTThis operation returns a candidate by email.
Retrieve Candidate by IDretrieveCandidateByIdGETThis operation returns a candidate by ID.
Retrieve Candidate Reference by IDretrieveCandidateReferenceByIdGETThis operation returns a candidate reference by candidate ID and reference ID.
Retrieve CandidatesretrieveCandidatesGETThis operation returns one or more candidates based on the specified criteria.
Retrieve Comments by Candidate IDretrieveCommentsByCandidateIdGETThis operation returns comments by candidate ID.
Retrieve Educations by Candidate IDretrieveEducationsByCandidateIdGETThis operation returns educations by candidate ID.
Retrieve Licenses by Candidate IDretrieveLicensesByCandidateIdGETThis operation returns licenses by candidate ID.
Retrieve Motivations by Candidate IDretrieveMotivationsByCandidateIdGETThis operation returns motivations by candidate ID.
Retrieve Name and Email by Candidate IDretrieveNameAndEmailByCandidateIdGETThis operation returns the name and email of a candidate by ID.
Retrieve References by Candidate IDretrieveReferencesByCandidateIdGETThis operation returns references by candidate ID.
Retrieve Skills by Candidate IDretrieveSkillsByCandidateIdGETThis operation returns skills by candidate ID.
Retrieve Work Experiences by Candidate IDretrieveWorkExperiencesByCandidateIdGETThis operation returns work experiences by candidate ID.
Update Candidate Reference by IDupdateCandidateReferenceByIdPUTThis operation updates a candidate reference by candidate ID and reference ID.
Upload Document by Candidate IDuploadDocumentbyCandidateIDPOSTThis operation uploads a document by candidate ID.
Recruiting: Configuration and Settings36
Archive or Unarchive Behavior by IDarchiveOrUnarchiveBehaviorPATCHThis operation archives or unarchives a behavior by ID.
Archive or Unarchive Motivation by IDarchiveOrUnarchiveMotivationByIdPATCHThis operation archives or unarchives a motivation by ID.
Archive or Unarchive Physical Location by IDarchiveOrUnarchivePhysicalLocationByIdPATCHThis operation archives or unarchives physical locations.
Create Applicant SourcecreateApplicantSourcePOSTThis operation creates an applicant source.
Create BehaviorcreateBehaviorPOSTThis operation creates a behavior.
Create Disposition ReasoncreateDispositionReasonPOSTThis operation creates a disposition reason.
Create MotivationcreateMotivationPOSTThis operation creates a motivation in UKG Pro Recruiting.
Create Physical LocationcreatePhysicalLocationPOSTThis operation creates a physical location record in UKG Pro Recruiting.
Retrieve All Applicant SourcesretrieveAllApplicantSourcesGETThis operation returns all applicant sources in UKG Pro Recruiting.
Retrieve All BehaviorsretrieveAllBehaviorsGETThis operation returns all behaviors in UKG Pro Recruiting.
Retrieve All Disposition ReasonsretrieveAllDispositionReasonsGETThis operation returns all disposition reasons in UKG Pro Recruiting.
Retrieve All Fields of StudyretrieveAllFieldsOfStudyGETThis operation returns all educational fields of study in UKG Pro Recruiting.
Retrieve All Job BoardsretrieveAllJobBoardsGETThis operation returns all job boards in UKG Pro Recruiting.
Retrieve All Legal EntitiesretrieveAllLegalEntitiesGETThis operation returns all legal entities in UKG Pro Recruiting.
Retrieve All MotivationsretrieveAllMotivationsGETThis operation returns all motivations in UKG Pro Recruiting.
Retrieve All PrefixesretrieveAllPrefixesGETThis operation returns a list of all name prefixes in UKG Pro Recruiting.
Retrieve All Proficiency LevelsretrieveAllProficiencyLevelsGETThis operation returns a list of all proficiency levels (for example: beginner, intermediate, expert) that are available in UKG Pro Recruiting for a candidate to assign to a Skill.
Retrieve All Recruiting ProcessesretrieveAllRecruitingProcessesGETThis operation returns all recruiting processes in UKG Pro Recruiting.
Retrieve All SuffixesretrieveAllSuffixesGETThis operation returns all of the name suffixes (such as Jr.) that are available in UKG Pro Recruiting.
Retrieve All Tax LocationsretrieveAllTaxLocationsGETThis operation returns all tax locations in the system.
Retrieve Applicant Source by IDretrieveApplicantSourceByIdGETThis operation returns an applicant source by ID.
Retrieve Behavior by IDretrieveBehaviorByIdGETThis operation returns a behavior by ID.
Retrieve Disposition Reason by IDretrieveDispositionReasonByIdGETThis operation returns a disposition reason by ID.
Retrieve Field of Study by IDretrieveFieldOfStudyByIdGETThis operation returns a field of study by ID.
Retrieve Job Board by IDretrieveJobBoardByIdGETThis operation returns a job board by ID.
Retrieve Legal Entity by IDretrieveLegalEntityByIdGETThis operation returns a legal entity by ID.
Retrieve Motivation by IDretrieveMotivationByIdGETThis operation returns a motivation by ID.
Retrieve Org Unit by IDretrieveOrgUnitByIdGETThis operation returns an org unit by ID.
Retrieve Org UnitsretrieveOrgUnitsGETThis operation returns all org units in the system.
Retrieve Physical Location by IDretrievePhysicalLocationByIdGETThis operation returns a physical location by ID.
Retrieve Physical LocationsretrievePhysicalLocationsGETThis operation returns all physical locations in UKG Pro Recruiting or a list of physical locations constrained by the specified filtering criteria.
Retrieve Prefix by IDretrievePrefixByIdGETThis operation returns a prefix by ID.
Retrieve Proficiency Level by IDretrieveProficiencyLevelsByIdGETThis operation returns a proficiency level by ID (for example: beginner, intermediate, expert) that is available in UKG Pro Recruiting for a candidate to assign to a Skill.
Retrieve Recruiting Process By IDretrieveRecruitingProcessesByIdGETThis operation returns a recruiting process by ID.
Retrieve Suffix By IDretrieveSuffixByIdGETThis operation returns a name suffix (such as “Jr.”) by ID.
Retrieve Tax Location by IDretrieveTaxLocationByIdGETThis operation returns a tax location by ID.
Recruiting: Offers4
Create OffercreateOfferPOSTThis operation creates an offer.
Retrieve Offer Actions by Offer IDretrieveOfferActionsByOfferIdGETThis operation returns all offer actions by offer ID.
Retrieve OffersretrieveOffersGETThis operation returns all available offers.
Submit Offer for Approval by IDsubmitOfferForApprovalByIdPOSTThis operation submits an existing offer for approval by offer ID.
Recruiting: Opportunities21
Close Opportunity by IDcloseOpportunityByIdPOSTThis operation closes an opportunity by ID.
Create OpportunitycreateOpportunityPOSTThis operation creates an opportunity.
Create Opportunity AssessmentcreateOpportunityAssessmentPOSTThis operation creates an opportunity assessment.
Create Opportunity Screening QuestioncreateOpportunityScreeningQuestionPOSTThis operation creates an opportunity screening question.
Deactivate Opportunity Screening QuestionsdeactivateOpportunityScreeningQuestionsPATCHThis operation deactivates an opportunity screening question by ID.
Delete Opportunity Assessment by IDdeleteOpportunityAssessmentByIdDELETEThis operation deletes an opportunity assessment by ID.
Get ApiOpportunitiesSharedWithretrieveRecruitersAnOpportunityIsSharedWithGETReturns a list of recruiter/hiring managers the opportunity is shared with.
Publish Opportunity by IDpublishOpportunityByIdPOSTThis operation publishes an opportunity by ID.
Refresh Opportunity by IDrefreshOpportunityByIdPOSTThis operation refreshes an opportunity by ID.
Reopen Opportunity by IDreopenOpportunityByIdPOSTThis operation reopens a closed opportunity by ID.
Retrieve All Opportunity AssessmentsretrieveAllOpportunityAssessmentsGETThis operation returns all opportunity assessments in UKG Pro Recruiting.
Retrieve OpportunitiesretrieveOpportunitiesGETThis operation returns all opportunities in UKG Pro Recruiting or a filtered list of opportunities based on the specified criteria.
Retrieve Opportunity Assessment by IDretrieveOpportunityAssessmentByIdGETThis operation returns an opportunity assessment by ID.
Retrieve Opportunity by IDretrieveOpportunityByIdGETThis operation returns an opportunity by ID.
Retrieve Opportunity Country QuestionsretrieveOpportunityCountryQuestionsGETThis operation returns an array of country questions for an opportunity.
Retrieve Opportunity Screening Question including consents by IDretrieveOpportunityVendorScreeningQuestionByIdGETThis operation returns a single opportunity screening question by ID, including consent questions if applicable.
Retrieve Opportunity Screening QuestionsretrieveOpportunityScreeningQuestionsGETThis operation returns all opportunity screening questions associated with a particular opportunity.
Retrieve Opportunity Screening Questions including consentsretrieveOpportunityVendorScreeningQuestionsGETThis operation returns all opportunity screening questions associated with a particular opportunity, including consent questions (General Consent, SMS Consent, Copy Applicant Consent)...
Share Opportunity With RecruitershareOpportunityWithRecruiterPOSTThis operation adds a recruiter or hiring manager to the opportunity shared with list.
Update Opportunity Assessment by IDupdateOpportunityAssessmentByIdPUTThis operation updates an opportunity assessment by ID.
Update Opportunity Screening Question by IDupdateOpportunityScreeningQuestionByIdPUTThis operation updates an opportunity screening question by ID.
Recruiting: Post new token request1
Obtain New oAuth TokenpostSigninOauth2TTenantNameAccessTokenPOSTThis operation provides a new token to use in subsequent service requests ONLY for services that use oAuth.
Recruiting: Prehire Assessments and WOTC Surveys4
Create Assessment by IDcreateAssessmentByIdPOSTThis operation creates an assessment by candidate ID.
Retrieve Assessment by IDretrieveAssessmentByIdGETThis operation returns an assessment by candidate ID and assessment ID.
Retrieve Assessments by Candidate IDretrieveAssessmentsByCandidateIDGETThis operation returns assessments by candidate ID.
Update Assessment by IDupdateAssessmentByIdPUTThis operation updates an assessment by candidate ID and assessment ID.
Recruiting: Third Party Job Sites2
Retrieve Application Disposition Events by Third Party Job Site Integration IDretrieveApplicationDispositionEventsByThirdPartyJobSiteIntegrationIdGETThis operation returns application disposition events by third party job site integration ID.
Retrieve Third Party Job Site Postings by Integration IDretrieveThirdPartyJobSitePostingsByIntegrationIdGETThis operation returns third party job site postings by integration ID, which is a unique identifier provided by UKG during the integration registration process.