Reference · built on requestConnectorHR, scheduling & workforce

UKG Pro

Person, employment, compensation, PTO, and pay statement data from UKG Pro HCM REST services, with webhook events for hires.

Request accessPricing ↗

About

UKG Pro is the HCM suite from UKG for HR, payroll, and talent. Its Developer Hub documents REST services under /personnel/v1, /payroll/v1, and /configuration/v1, alongside older SOAP services and Reports-as-a-Service for Cognos reports. Endpoints are hosted per customer at a base service URL found under System Configuration > Security > Web Services.

Through Fibric, an operator reads person, employment, and compensation details, polls employee changes, and proposes a PTO plan update or a payroll earnings import. You approve it. The write is sent once and a receipt is kept.

This is a reference listing. It documents what Fibric would read from UKG Pro and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Person details through GET /personnel/v1/person-details, filtered by company, employee, name, email, or change date
  • Employment details through GET /personnel/v1/employment-details, including job, status, supervisor, hire, and termination dates
  • Compensation details through GET /personnel/v1/compensation-details, with pay group, shift, and salary-or-hourly codes
  • Employees changed between two dates through GET /personnel/v1/employee-changes
  • PTO plans per employee through /personnel/v1/companies/{companyId}/employees/{employeeId}/pto-plans
  • Pay statements for an employee and date range through /payroll/v1/employees/pay-statements
  • Pro HCM Webhook Events such as Person Hired, delivered to https://{hostname}/webhooks with a bearer token

Proposed actions

  • Target capability: propose a PTO plan update through PATCH /personnel/v1/companies/{companyId}/employees/{employeeId}/pto-plans/{ptoPlan}
  • Target capability: propose earnings for a payroll run through POST /services/payroll/v1/import-pay-items/earnings
  • Target capability: propose a PTO plan assignment through POST /personnel/v1/pto-plans

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Start onboarding from a Person Hired event

    The Person Hired webhook fires from the Add Employee wizard or an import. The operator reads person and employment details and proposes the onboarding tasks to run.

    With Onboarding Checklist

  • Sweep access on termination

    Employment details carry dateOfTermination and employeeStatusCode. Each polling window, the operator lists newly terminated employees and proposes the accounts to disable elsewhere.

    With Offboarding Sweep

  • Keep leave requests from colliding

    PTO plans and time off requests show balances and dates. The operator flags overlapping requests on one team and proposes which to approve.

    With Leave Conflict

Requirements

  • A web service account created by a system administrator under System Configuration > Security > Service Account Administration
  • The user API key assigned to that account and the customer API key sent as US-Customer-Api-Key
  • View, Add, or Edit roles granted per web service, such as Employee Person Details or PTO Plan Integration
  • Your service endpoint hostname from System Configuration > Security > Web Services; it varies by datacenter and environment
Authentication
HTTP basic authentication with a web service account's username and password, plus the US-Customer-Api-Key header; onboarding and recruiting APIs use a bearer token instead.

Limits

  • An API gateway enforces quotas per client, normally over one minute, and answers with HTTP 429; wait one second before retrying
  • employee-changes should be called no more than eight times a day, at least three hours apart, and returns whole records to compare
  • Reports-as-a-Service downloads time out after five minutes; UKG recommends smaller reports
  • Default pagination applies when page and per_Page are omitted

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request UKG Pro ↗

Questions and answers

What credentials does UKG Pro require?
A web service account with granular permissions, created under Service Account Administration. Each account has a user API key. Calls send HTTP basic credentials and the US-Customer-Api-Key header to your customer-specific service endpoint. Onboarding and recruiting APIs use a bearer token instead.
How do I detect employee changes?
Poll GET /personnel/v1/employee-changes with a start and end date. UKG asks for no more than eight calls a day, at least three hours apart, and returns full records rather than deltas, so compare against your previous pull. Pro HCM Webhook Events such as Person Hired are also available.
What happens when the rate limit is hit?
The API gateway returns HTTP 429. UKG says this is not an error but a request to slow down. Until a Retry-After header ships, wait one second before resuming, or back off exponentially. Do not try to route around the limit.
Ask about UKG Pro

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.

This connector listing is developed, published, and supported by Fibric. It describes integration with UKG Pro through published interfaces. Third-party names and logos identify the systems an integration connects to; they are the property of their respective owners, who are not affiliated with Fibric and do not sponsor or endorse this listing. Trademark policy