> ## Documentation Index
> Fetch the complete documentation index at: https://www.composer.id/llms.txt
> Use this file to discover all available pages before exploring further.
# UKG
> UKG (HRIS / HCM): the API posture, publish target and field mapping composerID publishes a decision reference through.
This page records how composerID publishes into UKG: the vendor's API posture, the publish target and field mapping, and the documentation each claim rests on. It is for anyone evaluating the connection or building against it.
UKG is a human capital management suite with three product lines behind one developer hub: UKG Pro (HCM, payroll and Recruiting), UKG Pro Workforce Management (the former Dimensions: time and scheduling) and UKG Ready (mid-market HCM). Each line has its own REST reference, hosts and credential model, so the destination is really the product line the tenant runs. composerID publishes the approved permanent-hire decision against the UKG Pro Recruiting Opportunity (the requisition object) and carries the Intent ID in a tenant-configured custom field on that record, holding the linkage on its own side until that field is confirmed writable and readable back.
Category: HRIS / HCM. Coverage status: Specification mapped. Vendor documentation: public developer portal.
## Integration path
How composerID connects to this destination, at a glance.
| Step | Detail |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authentication | UKG Pro: HTTP Basic with a web-services service account plus the US-Customer-Api-Key header (a per-customer API key issued in the tenant). |
| composerID publishes | Job requisition (Opportunity): UKG Pro Recruiting: Opportunity (create where the tenant's Recruiting API exposes it; otherwise the decision reference attaches to a recruiter-opened Opportunity) |
| Intent ID lands on | `job_requisition` `customFields.intentId`, held by composerID against the destination record |
| Back-sync | Webhooks and polling: some lifecycle events are pushed, the rest are read on a schedule. |
## Vendor documentation
## API posture
| Aspect | Detail |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authentication | UKG Pro: HTTP Basic with a web-services service account plus the US-Customer-Api-Key header (a per-customer API key issued in the tenant); Recruiting APIs are credentialed separately from the core web-services account, and the grant model is confirmed at onboarding. UKG Pro WFM: OAuth 2.0 access token from the authentication endpoint plus an appkey header issued on the developer hub. UKG Ready: a company-scoped API key exchanged through the login call for a session token. |
| Style | REST, JSON. Three product lines (UKG Pro, UKG Pro WFM, UKG Ready) with separate references, versioning and hosts; legacy UKG Pro SOAP web services remain for some employee writes. |
| Base URL | UKG Pro [https://service\\\{n\\}.ultipro.com/\\\{service\\}/v1](https://service\\\{n\\}.ultipro.com/\\\{service\\}/v1) \| UKG Pro WFM https\://\{tenant}.\{env}.mykronos.com/api/v1 \| UKG Ready [https://secure\\\{n\\}.saashr.com/ta/rest/v2/companies/\\\{cid\\}](https://secure\\\{n\\}.saashr.com/ta/rest/v2/companies/\\\{cid\\}) |
| Webhooks | No general outbound webhooks on UKG Pro; changes are polled through the Employee Changes API against a last-checked timestamp. UKG Pro WFM raises events into its Integration Hub rather than to arbitrary endpoints. UKG Ready offers tenant-configured webhook notifications for some record events (confirm coverage per company). Treat the suite as poll-first. |
| Events posture | Webhooks and polling |
| Rate limits | Not published as a single figure across the suite. UKG Pro WFM documents per-tenant rate limiting with HTTP 429; UKG Pro and UKG Ready thresholds are agreed per tenant. Back off exponentially on 429 everywhere. |
| Objects | UKG Pro: employee person details, employment details, jobs, org levels, employee changes, Recruiting opportunities, candidates, applications. UKG Pro WFM: persons and person assignments, schedules, timecards, hyperfind queries. UKG Ready: employees (external\_id), applicant-tracking job requisitions and applicants. |
## Publish target and field mapping
Each object below pairs the canonical intent fields with the destination's own fields and operations. The mapping is indicative until it is confirmed against a tenant at onboarding.
| Mapping | Detail |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Canonical to destination | role\_title, org\_level, location, headcount, target\_start\_date |
| Target | UKG Pro Recruiting: Opportunity (create where the tenant's Recruiting API exposes it; otherwise the decision reference attaches to a recruiter-opened Opportunity) |
| Requirement | Required |
| Notes | Opportunity is Pro Recruiting's requisition object. Whether the Recruiting API accepts Opportunity create, and its writable fields and approval behaviour, is indicative until confirmed against the tenant's Recruiting API reference at onboarding. |
| Mapping | Detail |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Canonical to destination | intent\_id -> tenant-configured custom field on the Opportunity (indicative); UKG Ready tenants: job requisition custom field, or external\_id on the hired employee record |
| Target | Opportunity custom field / UKG Ready custom field or employee external\_id |
| Requirement | Required |
| Notes | Link-only until a writable field that is returned on read is confirmed for the tenant's product line; composerID holds the linkage on its side either way. Deep link \{tenant\_host}/recruiting/opportunities/\{external\_id} (illustrative). |
| Mapping | Detail |
| ------------------------ | ---------------------------------------------------------------------------------------------------------- |
| Canonical to destination | employee\_id, employment\_status, hire\_date |
| Target | UKG Pro Personnel: Employee Changes API (poll) |
| Requirement | Read scope only |
| Notes | Polled against a last-checked timestamp. UKG Ready webhooks supplement where the company has them enabled. |
Establish which product line the tenant runs first: UKG Pro, UKG Pro WFM and UKG Ready have different hosts, credentials and references, and a customer may run two. UKG Pro service accounts need the web-services role and the customer API key; Recruiting access is granted separately and only the tenant can say whether its Recruiting API accepts Opportunity create at all. Confirm at onboarding whether the Opportunity exposes a client-writable custom field that is returned on read (ideally filterable); until then the Intent ID carrier is link-only. Rate limits for UKG Pro and UKG Ready are agreed per tenant.
## Next steps
The five ways composerID reaches a destination, and the minimum a destination must offer.
Plan, preflight and publish: how a decision becomes a valid record in a destination.
Every destination composerID documents, with its category and coverage status.