UKG Pro API Configuration Lite
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "ukg_pro",
"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
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"password": "your_ukg_pro_password",
"hostname": "your_ukg_pro_hostname",
"customer_api_key": "your_ukg_pro_customer_api_key",
"username": "your_ukg_pro_username",
"schema": "schema_name"
}
}Config parameters
| Name | Description |
|---|---|
password | Your UKG Pro password. |
hostname | Your UKG Pro hostname. |
customer_api_key | Your UKG Pro Customer API key. |
username | Your UKG Pro username. |
schema | 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
username,password,hostnameandcustomer_api_keyparameters in the request.POST https://api.fivetran.com/v1/connections{ "service": "ukg_pro", "group_id": "group_id", "config": { "username": "your_ukg_pro_username", "password": "your_ukg_pro_password", "hostname": "your_ukg_pro_hostname", "customer_api_key": "your_ukg_pro_customer_api_key" } }By using the Connect Card or the Fivetran dashboard.