UKG Pro Workforce Management API Configuration Lite

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "ukg_pro_workforce_management",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "auth_environment": "your_ukg_pro_workforce_management_auth_base_url",
    "auth_type": "client_credentials",
    "client_id": "your_ukg_pro_workforce_management_client_id",
    "client_secret": "your_ukg_pro_workforce_management_client_secret",
    "host_name": "your_ukg_pro_workforce_management_host_name",
    "organization": "your_ukg_pro_workforce_management_organization_id",
    "password": "your_ukg_pro_workforce_management_password",
    "username": "your_ukg_pro_workforce_management_username",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`auth_environment`	Your UKG Pro Workforce Management Auth base URL.
`auth_type`	The authentication method you want to use for your connection.
`client_id`	Your UKG Pro Workforce Management client ID.
`client_secret`	Your UKG Pro Workforce Management client secret.
`host_name`	Your UKG Pro Workforce Management hostname.
`organization`	Your UKG Pro Workforce Management Organization ID.
`password`	Your UKG Pro Workforce Management password.
`username`	Your UKG Pro Workforce Management username.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the host_name, client_id, client_secret, username, password, auth_type, organization and auth_environment parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "ukg_pro_workforce_management",
  "group_id": "group_id",
  "config": {
    "host_name": "your_ukg_pro_workforce_management_host_name",
    "client_id": "your_ukg_pro_workforce_management_client_id",
    "client_secret": "your_ukg_pro_workforce_management_client_secret",
    "username": "your_ukg_pro_workforce_management_username",
    "password": "your_ukg_pro_workforce_management_password",
    "auth_type": "client_credentials",
    "organization": "your_ukg_pro_workforce_management_organization_id",
    "auth_environment": "your_ukg_pro_workforce_management_auth_base_url"
  }
}

By using the Connect Card or the Fivetran dashboard.