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:
config:auth_scheme=header_token_ukgpro
config:auth_token=<a random string that acts as a secure token. This will be used when configuring webhook in UKG pro -
step 5 of Add Subscription "At the Add Free Form Headers fields, enter a custom header key (x-onlink-key) and custom header value (the random string you typed here)">
config:ukgpro_url=https://{tenantId}.{hostname}/personnel/v1/employee-changes/{employeeId}
can be changed to any other REST API - see this listconfig:auth_username=<webservice account username from UKG>
reference - UKG web service account has username, password, and an API keyconfig:auth_password=<webservice account password from UKG>
config:us_customer_api_key=<webservice account api key from UKG>
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.