ADP Workforce Now API Configuration

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": "adp_workforce_now",
  "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": {
    "client_id": "test_client_id",
    "client_secret": "test_client_secret",
    "private_key": "xxxxx-xxxxx-xxxxx-xxxxx",
    "ws_certificate": "xxxxx-xxxxx-xxxxx-xxxxx",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`client_id`	Your ADP Client ID.
`client_secret`	Your ADP Client Secret.
`private_key`	Private Key.
`ws_certificate`	Web Services Certificate.
`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 client_id, client_secret, ws_certificate and private_key parameters in the request.

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

{
  "service": "adp_workforce_now",
  "group_id": "group_id",
  "config": {
    "client_id": "test_client_id",
    "client_secret": "test_client_secret",
    "ws_certificate": "xxxxx-xxxxx-xxxxx-xxxxx",
    "private_key": "xxxxx-xxxxx-xxxxx-xxxxx"
  }
}

By using the Connect Card or the Fivetran dashboard.