Before you start
You need a UKG Ready company administrator who can open Company Setup and manage security profiles and reports.
You need the UKG Ready Recruitment product.
You will paste seven things into Metaintro:
Your UKG Ready host
Your company ID
The OAuth client ID and client secret
The ID of an applicant report, and the names of two of its fields
Create the credential in UKG Ready
These steps follow UKG Ready's REST API documentation, under Authentication and security.
Create the OAuth application
Go to Settings > Global Setup > Company Setup.
Find the widget titled OAuth Applications and create a new application.
Choose the type Machine to Machine. Metaintro signs in with the client credentials flow, which only works with this type.
Copy the client ID and client secret. Keep the secret somewhere safe.
Give the application access
UKG Ready checks every call against the security profile of the OAuth application, the same way it checks a person who signs in. Give that security profile access to:
Applicants (read and create)
Job applications (read, create and update)
Job requisitions (read)
The hiring stages list
The applicant report below, covering all applicants, with no date or status limits
UKG's public documentation does not list the exact security item names. Use the items you would give a recruiter who manages these records.
Choose the applicant report
Metaintro finds existing applicants by searching a global applicant list report by email. The report must:
Be exportable
Include the applicant's numeric account ID, and allow sorting on it
Include the applicant's primary email, and allow filtering on it with "equals"
You will need three values from it:
Report ID: global report IDs look like REPORT_SOMETHING. UKG lists them through its API rather than on a screen, so ask your UKG contact if you can't find it.
Account ID field name and primary email field name: the field names exactly as the report's metadata lists them. Field names are case-sensitive.
Find your host and company ID
Host: the host in your UKG Ready web address, such as secure4.saashr.com.
Company ID: your numeric UKG Ready company ID.
Connect in Metaintro
In Metaintro, go to Settings > Integrations.
Choose UKG Ready Recruitment.
Fill in each field:
UKG Ready host: your host, such as secure4.saashr.com
Company ID: your numeric company ID
OAuth client ID: the client ID
OAuth client secret: the client secret
Applicant report ID: the report ID
Applicant account ID field: the account ID field name
Applicant primary email field: the primary email field name
Select Connect.
Metaintro checks the report when you connect. If it is not exportable, or the fields cannot be sorted and filtered as described, the connection is refused.
Then map your requisitions, set your rules, check the preview and go live.
What Metaintro sends and reads
Metaintro only sends people who chose to share their profile with you for a specific job.
Requisitions: Metaintro reads your job requisitions so you can map them.
Applicant: Metaintro looks for an existing applicant with exactly the same primary email. If there is none, it creates one with their name, email, phone and summary. The email is also their UKG Ready username.
Job application: the applicant is applied to the mapped requisition, unless they already applied to it.
Proof card: a link to their proof card goes in the job application's company comment.
Metaintro checks each job application's hiring stage and status regularly and shows when someone is hired, rejected or withdraws. When a stage is changed from Metaintro, it moves the application to the hiring stage whose name matches, if there is one. It does not reopen an application that is already hired, rejected or withdrawn.
Limits
Résumé files are not sent. UKG Ready's API has no way to attach them to an applicant.
UKG Ready has no notes on applicants. Metaintro uses the company comment, which holds up to 1,024 characters. The proof card link is always kept whole.
Applicants need an email of at most 75 characters, because UKG Ready uses it as their username.
Status updates are checked on a schedule, not sent instantly.
UKG Ready limits each company to between 500 and 1,500 API calls a minute, depending on its size. That limit is shared with your other integrations. Metaintro paces its calls and waits when UKG Ready asks it to.
If something goes wrong
The client ID or secret is rejected: check that the OAuth application is the Machine to Machine type, and that the host and company ID are right.
Access is refused: add the missing access to the OAuth application's security profile.
The report is refused when you connect: make sure the report is exportable, the account ID field can be sorted, and the email field can be filtered with "equals". Check the field names match exactly.
An existing applicant is not matched: the report filter must find the email regardless of upper or lower case. Check the report covers all applicants.
Too many requests: your company reached its UKG Ready call limit. Metaintro waits and tries again by itself.