Workday RaaS API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "workday",
  "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": {
    "reports": [
      {
        "primary_keys": [
          "string"
        ],
        "sync_strategy": "FROM_LAST_SYNCED_DATE | FROM_START_DATE",
        "generate_fivetran_pk": true,
        "report_url": "workday_report_url",
        "report_format_type": "csv | json",
        "enable_dynamic_parameters": true,
        "start_date_parameter_field": "string",
        "dynamic_parameter_field": "string",
        "table": "string",
        "support_nested_columns": true,
        "start_date": "string"
      }
    ],
    "primary_keys": [
      "string"
    ],
    "authorization_url": "string",
    "user_name": "workday_username",
    "report_url": "workday_report_url",
    "auth_mode": "BASIC | OAUTH",
    "support_nested_columns": true,
    "password": "workday_password",
    "domain_host_name": "string",
    "generate_fivetran_pk": true,
    "report_format_type": "csv | json",
    "tenant": "string",
    "schema": "schema_name"
  },
  "auth": {
    "refresh_token": "string",
    "client_secret": "string",
    "client_id": "string"
  }
}

Config parameters

Name	Description
`reports`	The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
`reports[0].primary_keys`	Primary Keys
`reports[0].sync_strategy`	Dynamic report parameters sync strategy
`reports[0].generate_fivetran_pk`	Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
`reports[0].report_url`	URL for a live custom report.
`reports[0].report_format_type`	This is to select report format from JSON and CSV. By default, report format is JSON.
`reports[0].enable_dynamic_parameters`	Select this option to enable dynamic report parameters.
`reports[0].start_date_parameter_field`	Start date parameter field name
`reports[0].dynamic_parameter_field`	Dynamic parameter field name
`reports[0].table`	The table name within the schema to which connector will sync the data of the specific report.
`reports[0].support_nested_columns`	This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
`reports[0].start_date`	Start date
`primary_keys`	Primary Keys
`authorization_url`	Authorization URL
`user_name`	Workday username.
`report_url`	URL for a live custom report.
`auth_mode`	Authentication Mode
`support_nested_columns`	This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
`password`	Workday password.
`domain_host_name`	Workday host name.
`generate_fivetran_pk`	Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
`report_format_type`	This is to select report format from JSON and CSV. By default, report format is JSON.
`tenant`	Workday tenant name
`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 user_name, password and report_url parameters in the request.

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

{
  "service": "workday",
  "group_id": "group_id",
  "config": {
    "user_name": "workday_username",
    "password": "workday_password",
    "report_url": "workday_report_url"
  }
}

By using the Connect Card or the Fivetran dashboard.