Workday | DataGrail Documentation
Workday Integration Documentation
This documentation for the Workday integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Workday, visit our connection instructions.
Version
This integration utilizes the MergeHR, Payroll, and Directory (HRIS) API v1.
Base URL
The base URL used for all Workday API endpoints:
https://api.merge.dev/api/hris/v1
Endpoints Utilized
DataGrail uses the following endpoints to authorize and test the connection:
| Method | Endpoint | Purpose | Docs |
|---|---|---|---|
| GET | /employees |
Verify connection |
Authentication & Authorization
The DataGrail Workday integration connects using Merge API authentication which requires an API Key.
Sensitive Credentials
Publicly exposing your API credentials can allow unauthorized access to Workday API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.
Limits
Limits in Workday are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.
- DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
- DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).
Capabilities
Access
DataGrail's Workday integration provides Asynchronous Access capabilities for the following supported identifier category: Email.
Data Interactions
For Access requests, DataGrail will take the following actions:
- Search employees by configured identifiers.
Endpoints Utilized
| Method | Endpoint | Purpose | Docs |
|---|---|---|---|
| GET | /employees |
Search employees |
Data Discovery
DataGrail's Workday integration provides data discovery capabilities based on the principle of finding any and all personal data that's stored in a data system.
Data Interactions
For discovery requests, DataGrail will take the following actions:
- Fetch available (enabled) objects from the following Merge! models:
Supported Objects
- employees,
- dependents,
- bank_info,
- employments,
- employee_payroll_runs,
- benefits,
- time_off,
- time_off_balances,
- timesheet_entries,
- locations,
- Sample data for the next analysis and classification.
Endpoints Utilized
| Method | Endpoint | Purpose | Docs |
|---|---|---|---|
| GET | /bank-info |
Fetch BankInfo objects | |
| GET | /benefits |
Fetch benefits | |
| GET | /dependents |
Fetch dependents | |
| GET | /employee-payroll-runs |
Fetch EmployeePayrollRun objects | |
| GET | /employees |
Fetch employees | |
| GET | /employments |
Fetch employments | |
| GET | /locations |
Fetch locations | |
| GET | /time-off |
Fetch TimeOff objects. | |
| GET | /time-off-balances |
Fetch TimeOffBalance objects. | |
| GET | /timesheet-entries |
Fetch TimesheetEntry objects. |
If you have any questions, please reach out to your dedicated Account Manager or contact us at support@datagrail.io.