Page Comparison

Follow instructions in our Webhook documentation to understand how OnLink supports webhooks. Here are the config elements you will need to configure UKG Pro webhooks. This allows OnLink to receive Hire or Termination or Employee Change events from UKG. OnLink then creates Jira issues based on these events.

Follow instructions here to configure webhook in UKG Pro: https://developer.ukg.com/hcm/docs/ukg-webhooks-user-guide

Then add below config parameters to the webhook mapping in OnLink:

config:auth_scheme=header_token_ukgpro
config:headerauth_token=<create a secure 20 char token, will be used <a random 12 character password string that acts as a secure token> Use this string when configuring webhook in UKG pro>
config:ukgpro_url=https://{tenantId}.{hostname}/personnel/v1/employee-changes/{employeeId} can be changed to any other REST API - see this list
config:auth_username=<webservice account username from UKG> ref - Each web service account is assigned a unique user API key. This user API key along with the web service account username and password is necessary for authentication to an endpoint.
config:auth_password=<webservice account password>
config:auth_password=<webservice account api key>

Follow instructions here to configure webhook in UKG Pro: https://developer.ukg.com/general/docs/ukg-webhooks-user-guide#add-a-subscription

Here’s the field mapping

key:employeeId=customfield_10121
map:firstName=customfield_10065
map:lastName=customfield_10066

Any field supported by UKG Pro API can be mapped in this way.

Image Removedpro - specifically, step 5 of Add Subscription asks you to add a free form headers fields. Set the custom header key to x-onlink-token and custom header value to the random password string. Note that this random password is encoded once you save the settings and cannot be retrieved back.

OnLink combines employee demographic data and employment data and makes it available for mapping. Any field supported by UKG Pro API can be mapped in this way. Your UKG Pro service account must have the "View" role for the "Personnel Integration" Web Service.

key:employeeId=customfield_10062
map:firstName=customfield_10063
map:lastName=customfield_10064
map:demographicData.companyId=customfield_10065
map:demographicData.addressLine1=customfield_10066
map:jobData.jobTitle=customfield_10067
map:jobData.supervisorId=customfield_10068
map:jobData.originalHireDate=customfield_10069

Image Added