.png)
UKG Pro Workforce Management Integration Guide
Integrate UKG Pro Workforce Management with enterprise applications through REST APIs, OAuth 2.0, scheduled synchronization, web services, and supported file exchanges.
UKG Pro Workforce Management integration options at a glance
UKG Pro Workforce Management primarily integrates through UKG REST APIs exposed by the developer platform, with available resources varying by tenant, product version, region, and enabled modules. OAuth 2.0 provides the current authentication model, subject to tenant permissions and application scopes. Selected older deployments may expose SOAP or other web services, while batch-oriented imports, exports, and asynchronous operations may be available for specific products or resources. A general webhook model for all workforce objects was not confirmed, so scheduled incremental synchronization is often required. Martini can orchestrate these calls, process pagination and date ranges, transform JSON, apply business rules, and deliver results to downstream systems.
| Integration point | Supported by UKG Pro Workforce Management? | Common use cases | How Martini supports it |
|---|---|---|---|
| REST APIs | Yes | Retrieve or update supported Employees, Persons, Schedules, Timecards, Punches, Pay Codes, and Accruals. Exact resources and operations depend on the tenant and product version. | Martini can consume UKG REST APIs, manage OAuth-protected requests, paginate results, transform JSON, expose APIs for initiation, and handle response validation. |
| Authentication | Yes | Current UKG developer-platform integrations use OAuth 2.0 with application registration, client credentials, tenant authorization, scopes, and product permissions. | Martini stores credentials in environment configuration or secrets, obtains or uses access tokens, refreshes credentials where required, and protects them from workflow payloads. |
| SOAP APIs | Limited | Older UKG or Kronos deployments and selected services may expose SOAP or other web-service interfaces. A tenant-specific WSDL and endpoint must be confirmed. | Martini can consume SOAP services when UKG provides the applicable WSDL and endpoint, while REST remains the preferred approach when equivalent functionality exists. |
| Bulk, asynchronous, or batch processing | Limited | Batch, import, export, or asynchronous operations may be available for selected products, resources, or date-range workloads. | Martini can use bounded batches, pagination, checkpoints, asynchronous workflow execution, and retry handling without assuming a universal bulk endpoint. |
| File import and export | Limited | Scheduled file-based workforce imports and exports are common in enterprise UKG deployments, but formats, delivery channels, and data sets require confirmation. | Martini can orchestrate supported file exchanges, parse and transform file content, validate records, and route processing failures for review. |
| Webhooks and outbound callbacks | Not confirmed | A general webhook facility covering all UKG Pro Workforce Management objects was not confirmed. Selected event or notification mechanisms may exist by product or deployment. | Martini can receive a confirmed UKG callback, but otherwise uses scheduler-triggered incremental synchronization with checkpoints and overlap windows. |
| Scheduled synchronization | Yes | Polling is an appropriate fallback where native event delivery is unavailable, using change dates, last-modified values, effective dates, pay periods, or controlled time windows. | Martini Scheduler Triggers start workflows that retrieve pages, persist high-water marks, reconcile overlaps, and deliver normalized data downstream. |
| Database access | Not confirmed | Direct access to UKG’s SaaS production database should not be assumed. Supported APIs, reports, exports, or a customer-managed warehouse are the appropriate surfaces. | Martini can connect to a customer-managed database or warehouse when UKG data is separately staged there, but not directly to UKG’s underlying database. |
How UKG Pro Workforce Management exposes data and business events
UKG REST APIs
UKG provides REST-oriented APIs through its developer platform for supported workforce-management capabilities. Resources and operations vary by tenant, product version, module, and permissions, so the exact API family must be confirmed before implementation.
Martini implementation pattern
Martini implementation pattern: a workflow obtains an OAuth 2.0 token, calls the documented UKG resource, follows the tenant-specific pagination model, validates responses, maps JSON into a canonical model, and writes or submits the result to downstream systems.
Implementation sequence
Scheduled synchronization
A general all-object webhook model was not confirmed for UKG Pro Workforce Management. Scheduled incremental synchronization is therefore a practical approach using documented change filters, last-modified values, effective dates, pay-period boundaries, or controlled time windows.
Martini implementation pattern
Martini implementation pattern: a Scheduler Trigger starts a workflow, which reads a persisted high-water mark, retrieves an overlapping bounded window, deduplicates stable UKG identifiers, delivers changes, and records a successful checkpoint. Reconciliation jobs can detect missed or corrected data.
Implementation sequence
UKG SOAP or web services
Older UKG and Kronos deployments or selected services may expose SOAP or other web-service interfaces. Availability, WSDLs, authentication, and operations are deployment-specific and should be confirmed with the customer’s UKG documentation.
Martini implementation pattern
Martini implementation pattern: when a WSDL and endpoint are available, Martini consumes the SOAP service, maps XML request and response structures, validates business faults, and uses REST for equivalent new functionality where possible.
Implementation sequence
Batch and file exchanges
Enterprise UKG deployments may support batch-oriented imports, exports, or asynchronous operations for selected products and data sets. File formats, transport, and coverage must be confirmed for the specific environment.
Martini implementation pattern
Martini implementation pattern: a workflow retrieves or receives a supported file, validates its format and control totals, transforms rows into target payloads, processes records in bounded batches, and records rejected rows separately from successful delivery.
Implementation sequence
Common UKG Pro Workforce Management integration patterns
Pattern 1: Synchronize employees and persons
When to use this pattern
Use this pattern when UKG Pro Workforce Management is the source for workforce identity or employment data consumed by an HCM, identity, service, or operational application. It supports incremental processing where the tenant exposes a suitable change filter.
Integration direction
Example Mapping
| UKG Pro Workforce Management Field | Canonical Field | Target Field |
|---|---|---|
| employeeId | worker.externalId | Worker ID |
| employmentStatus | worker.status | Employment status |
| organization | worker.organizationCode | Department or organization |
| effectiveDate | worker.effectiveFrom | Effective date |
Martini implementation pattern
A scheduled Martini workflow obtains an OAuth token, retrieves changed Employees or Persons, follows pagination, normalizes identity and employment fields, applies effective-date and required-field rules, and upserts the target. Stable source identifiers and a persisted checkpoint prevent duplicates; authorization and validation failures are routed for operational review.
Martini capabilities used
- workflows
- Scheduler Trigger
- API consumption
- data mapping
- business rules
- error handling
- checkpointing
Pattern 2: Export timecards and punches to payroll
When to use this pattern
Use this pattern to deliver approved work time to ADP Workforce Now, Workday, Oracle HCM Cloud, NetSuite, or a reporting warehouse. It is designed for pay-period processing and later corrections.
Integration direction
Example Mapping
| UKG Pro Workforce Management Field | Canonical Field | Target Field |
|---|---|---|
| employeeId | time.workerId | Employee identifier |
| payCode | time.category | Earning or labor code |
| startTime/endTime | time.interval | Worked interval |
| approvalStatus | time.approvalState | Approval status |
Martini implementation pattern
Martini retrieves Timecards and Punches for a bounded pay period, validates approval state, time zones, Pay Codes, and employee references, then maps and upserts normalized time. The workflow uses idempotency keys based on source identifiers and pay periods, retries temporary failures, and retains rejected corrections for review.
Martini capabilities used
- workflows
- API consumption
- date-range processing
- data mapping
- validation
- business rules
- retry handling
Pattern 3: Distribute schedules to an operational application
When to use this pattern
Use this pattern when another application needs planned shifts, assignments, locations, or availability derived from UKG Schedules. It can support scheduled distribution or an API-led retrieval model.
Integration direction
Example Mapping
| UKG Pro Workforce Management Field | Canonical Field | Target Field |
|---|---|---|
| scheduleId | shift.externalId | Shift ID |
| employeeId | shift.workerId | Assigned worker |
| start/end | shift.interval | Shift start and end |
| location | shift.locationCode | Work location |
Martini implementation pattern
Martini retrieves supported Schedules, transforms nested shift structures into a downstream shift model, filters by department or location, and publishes the result. A Martini API can provide on-demand schedule retrieval, while correlation IDs, validation, and retry paths protect downstream consumers.
Martini capabilities used
- API consumption
- API exposure
- workflows
- data transformation
- conditional routing
- error handling
Pattern 4: Synchronize accrual balances and transactions
When to use this pattern
Use this pattern when an employee portal, HR application, finance process, or warehouse requires UKG leave balances or accrual activity. The design must distinguish balances from transactions and adjustments.
Integration direction
Example Mapping
| UKG Pro Workforce Management Field | Canonical Field | Target Field |
|---|---|---|
| employeeId | accrual.workerId | Worker identifier |
| accrualCode | accrual.planCode | Leave plan |
| balance | accrual.currentBalance | Current balance |
| effectiveDate | accrual.effectiveDate | Effective date |
Martini implementation pattern
A Martini workflow retrieves supported Accrual balances or transactions, maps plan codes and effective dates, applies employee-status and policy rules, and updates the target using stable source keys. Periodic reconciliation compares current balances with prior results and routes unexplained differences for review.
Martini capabilities used
- scheduled workflows
- API consumption
- mapping
- business rules
- reconciliation
- error handling
Applications commonly integrated with UKG Pro Workforce Management
UKG Pro Workforce Management can be integrated with adjacent HCM, payroll, financial, service-management, and operational applications. These are implementation patterns rather than claims of UKG-certified or native connections; the available direction and objects depend on each customer’s system ownership and tenant configuration.
| Application | Scenario | Direction | Martini Pattern |
|---|---|---|---|
| UKG Pro | Synchronize employees, organizational structures, jobs, and employment status between UKG HCM and workforce-management processes. | UKG Pro → Martini → UKG Pro Workforce Management | Use a scheduled Martini workflow to retrieve or receive approved worker changes, map identifiers and effective dates, validate required fields, and upsert Employees or Persons where the tenant exposes those resources. |
| Workday | Exchange worker, position, organization, time, or payroll-related data when Workday is the enterprise HCM or payroll system. | Workday → Martini → UKG Pro Workforce Management | Orchestrate scheduled API calls or supported file exchanges, normalize worker and organization data, apply ownership rules, and separately export approved UKG time results to Workday or payroll. |
| SAP SuccessFactors | Synchronize employees, departments, jobs, and employment status with scheduling and time-management processes. | SAP SuccessFactors → Martini → UKG Pro Workforce Management | Use Martini workflows for incremental master-data loads, field mapping, effective-date validation, pagination, and controlled retries before submitting supported UKG updates. |
| Oracle HCM Cloud | Exchange worker and organization data and return approved attendance or time information to the HCM and payroll environment. | Oracle HCM Cloud → Martini → UKG Pro Workforce Management | Maintain a canonical worker model in the workflow, route employee changes into UKG, and export normalized Timecards or Punches with pay-period and approval-state controls. |
| ADP Workforce Now | Transfer employee and time data to support payroll processing and reduce manual entry. | UKG Pro Workforce Management → Martini → ADP Workforce Now | Retrieve bounded pay-period data, map Pay Codes and employee identifiers, enforce idempotent delivery, and route rejected or corrected time entries for review. |
| ServiceNow | Make workforce or employee information available to service workflows, employee support, access processes, and operational reporting. | UKG Pro Workforce Management → Martini → ServiceNow | Expose a Martini API or schedule a UKG query, transform Employees or schedule data into ServiceNow payloads, apply filtering rules, and record correlation identifiers. |
| Salesforce | Make employee, field-workforce, or availability information available to customer-service and field-service processes. | UKG Pro Workforce Management → Martini → Salesforce | Poll supported UKG resources incrementally, map workforce attributes to Salesforce objects through a canonical model, and accept operational requests through a Martini API where appropriate. |
| NetSuite | Combine workforce time or labor-cost information with financial and operational reporting. | UKG Pro Workforce Management → Martini → NetSuite | Retrieve approved Timecards and Pay Codes, transform labor dimensions and dates, validate accounting mappings, and write idempotently to NetSuite or an intermediate data platform. |
How to build a UKG Pro Workforce Management integration in Martini
Objective
Establish the tenant-specific UKG API family, resource availability, OAuth 2.0 registration, permissions, and any required web-service or file details.
Instructions in Martini
- Confirm the UKG tenant, product version, modules, API resources, and region
- Register or obtain the customer application credentials
- Store client credentials and token configuration as Martini secrets or environment configuration
- Verify least-privilege permissions for the required workforce objects
Objective
Select an event, scheduled, file, or API-led entry point based on what the UKG tenant actually supports.
Instructions in Martini
- Use a confirmed UKG callback only for the selected event coverage
- Otherwise configure a Martini Scheduler Trigger for incremental polling
- Define date ranges, pay-period boundaries, overlap windows, and checkpoint behavior
- Expose a Martini REST API when another system must initiate synchronization
Objective
Call the selected UKG resources reliably and collect complete result sets without assuming a common pagination or bulk model.
Instructions in Martini
- Obtain or refresh the OAuth access token
- Call the supported REST or SOAP resource
- Follow the endpoint-specific pagination and filtering model
- Process bounded ranges and persist progress for long-running jobs
Objective
Coordinate retrieval, validation, transformation, target delivery, and exception handling as a maintainable Martini workflow.
Instructions in Martini
- Separate authentication, retrieval, mapping, delivery, and checkpoint stages
- Use conditional routing for approval states, object types, and validation outcomes
- Apply controlled concurrency rather than unbounded parallel requests
- Preserve correlation identifiers for tracing and reconciliation
Objective
Translate UKG payloads into a canonical model and then into the target application’s schema while preserving workforce-specific semantics.
Instructions in Martini
- Map Employees, Persons, Timecards, Punches, Schedules, Pay Codes, or Accruals explicitly
- Normalize employee identifiers, dates, time zones, status values, and effective dates
- Validate required fields and unmapped Pay Codes before delivery
- Apply target-specific transformations without coupling downstream systems to raw UKG structures
Objective
Deliver valid data to the target system with idempotency, business-rule enforcement, and clear handling for rejected records.
Instructions in Martini
- Use upsert operations where the target supports them
- Use stable UKG identifiers, pay periods, and source timestamps for idempotency
- Separate transient failures from permanent validation or authorization errors
- Record accepted, rejected, and retried items
Common UKG Pro Workforce Management data objects used in integrations
| Object | Typical Use | Common target systems | Martini handling |
|---|---|---|---|
| Employees | Synchronize workforce identity, employment status, organization, and worker attributes. | UKG Pro, Workday, SAP SuccessFactors, Oracle HCM Cloud, ADP Workforce Now, ServiceNow | Martini retrieves supported changes, paginates results, maps identifiers and effective dates, validates required fields, and upserts the target representation. |
| Persons | Exchange person and identity information associated with employees. | HCM platforms, identity processes, ServiceNow, Salesforce | Martini separates person and employment attributes in a canonical model, applies data-minimization rules, and routes incomplete or unauthorized records for review. |
| Timecards | Export recorded and calculated work time for a pay period or payroll process. | ADP Workforce Now, Workday, Oracle HCM Cloud, NetSuite, data warehouses | Martini processes bounded pay periods, approval state, corrections, Pay Codes, time zones, pagination, and idempotent target writes. |
| Punches | Transfer clock-in, clock-out, transfer, and related time-entry events. | Payroll systems, data warehouses, operational reporting platforms | Martini normalizes timestamps and employee identifiers, accounts for overnight shifts and daylight-saving changes, and deduplicates by stable source keys. |
| Schedules | Distribute planned shifts, assignments, locations, and work patterns. | Operational portals, mobile workforce applications, Salesforce | Martini transforms UKG schedule structures into target-specific shift models, applies location or department rules, and supports on-demand API retrieval. |
| Pay Codes | Classify worked, paid, non-worked, or other time categories. | Payroll, finance, NetSuite, reporting warehouses | Martini validates Pay Code mappings and effective dates before loading time results, routing unmapped values to an exception path. |
Authentication and security considerations
OAuth 2.0 and tenant authorization
Current UKG developer-platform integrations use OAuth 2.0, with application registration, client credentials, tenant authorization, scopes where applicable, and product or functional permissions. The exact token URL and permission model must be confirmed for the tenant.
Protect workforce data
- Store client credentials, token settings, and endpoints in Martini secrets or environment configuration.
- Use least-privilege UKG permissions and transfer only fields required by the target.
- Protect employee, time, schedule, and accrual data in transit and at rest according to the deployment’s security controls.
- Do not embed credentials in workflow payloads or source mappings.
Operational considerations for UKG Pro Workforce Management integrations
Tenant variation
API resources, versions, permissions, rate limits, pagination models, and write operations can vary by UKG product generation, tenant, region, enabled module, and licensing. Confirm the actual API family before implementation.
Reliable synchronization
- Use documented pagination and bounded date ranges.
- Respect 429 responses and tenant-specific throttling guidance with controlled exponential backoff.
- Persist high-water marks and use overlap windows for late updates.
- Use stable identifiers and pay-period keys for idempotency and duplicate prevention.
- Account for time zones, overnight shifts, daylight-saving changes, effective dates, corrections, and approval state.
- Distinguish authentication, authorization, validation, rate-limit, temporary service, and downstream failures.
- Test API-version changes and enumerations such as Pay Codes, locations, statuses, and schedule types.
Why use Martini instead of scripts or point-to-point integrations?
More than a point-to-point script
Martini provides a maintainable workflow layer around UKG APIs, web services, files, and scheduled synchronization. It separates vendor payloads from canonical and target models, centralizes authentication, and makes business rules reusable.
Operational control
- Orchestrate retrieval, transformation, validation, target delivery, and reconciliation in one workflow.
- Support API-led, scheduled, batch, and asynchronous execution patterns.
- Apply pagination, checkpoints, retries, idempotency, and exception routing consistently.
- Expose controlled APIs for upstream applications without exposing UKG-specific details.
- Monitor workflow outcomes and preserve useful correlation and error information for support teams.
Frequently asked questions
UKG Pro Workforce Management can be integrated primarily through tenant-specific REST APIs authenticated with OAuth 2.0. Selected deployments may also provide SOAP or other web services, batch operations, and file imports or exports. Where general webhook coverage is unavailable, scheduled incremental synchronization can retrieve workforce data such as Employees, Timecards, Punches, Schedules, Pay Codes, and Accruals.
Yes. Martini can consume the supported UKG REST APIs, use OAuth 2.0 credentials, process applicable web services or files, expose an API for upstream systems, and orchestrate scheduled synchronization. The exact resources and write operations must be confirmed for the customer’s UKG tenant.
No. A dedicated UKG connector is not required. Martini can integrate using UKG’s confirmed native REST APIs, OAuth 2.0 authentication, applicable SOAP or web-service interfaces, supported file exchanges, and scheduled workflows.
Lonti does not charge an additional per-connector or per-vendor fee to integrate UKG Pro Workforce Management. The integration is subject to the provisioned capacity of the Martini environment. Separate costs may apply from UKG, cloud infrastructure, payroll providers, or other third-party systems based on subscriptions, usage, and deployment model.
REST APIs with OAuth 2.0 are the primary approach where the tenant exposes the required resources. SOAP or other web services are secondary and deployment-specific, while batch and file exchanges may be appropriate for selected workloads. Direct database access and GraphQL APIs were not confirmed.
A general webhook facility for all UKG Pro Workforce Management objects was not confirmed. Selected products or business events may have notification mechanisms, but coverage must be verified. Martini can otherwise run scheduled incremental synchronization using documented change markers, effective dates, or controlled time windows.
Martini can use pagination, bounded date ranges, pay-period processing, persisted checkpoints, overlap windows, stable identifiers, and periodic reconciliation. Time zones, daylight-saving transitions, corrections, approval state, effective dating, and Pay Codes should be represented explicitly in the synchronization design.
Yes. Martini can expose a REST API that hides tenant-specific UKG details from consuming applications, applies authorization and validation, orchestrates UKG calls, transforms responses, and returns a controlled canonical model. This does not change which UKG resources or operations the tenant makes available.
Related Martini documentation
API Consumption
Data Handling
Security and Operations
Integrate UKG Pro Workforce Management with Martini
Use Martini to build secure, maintainable UKG Pro Workforce Management integrations for workforce data synchronization, time and attendance processing, scheduling, accruals, and enterprise automation.