Workday – How do I connect via API?
Updated 2 weeks ago
This guide will walk you through the steps of setting up an HRIS integration with Workday.
Create an ISU
Step 1: Click on the magic link to allow and continue.
Step 2: Navigate to your Workday Dashboard.
Step 3: Search for "Create Integration System User" and select it.
Step 4: Assign a username, for instance, Bindbee HRIS, and set password (DO NOT Generate Random Password).
Step 6: Leave all other parameters unchanged and click on "OK" and then "Done".
Ensure the password does not reset:
Step 1: Navigate to Maintain Password Rules.
Step 2: In Select users exempt from password expiration add the newly created Integration System User and press "OK", then "Done".
Create a new security group
Step 1: Navigate to create security group.
Step 2: From the type of connected security group, select the Integration System Security Group (Unconstrained).
Step 3: Assign a name to the group, and click "OK".
Step 5: Inside the security group, add the newly created user.
Step 6: Press "OK" and then "Done".
Manage Authentication Policies:
Step 1: Navigate to manage authentication policies.
Step 2: Go to the current policy and press edit.
Step 3: Create a new rule and name it appropriately. Also add the newly created security group.
Step 4: Set the Authentication Condition Name to "credentials" and leave the rest unchanged.
Step 5: Press "OK" and then "Done".
Step 6: Click on "Activate All Authentication Policies".
Step 7: Add a comment and press okay.
Step 8: Confirm the selection.
Maintain Permissions for Security Group
Step 1: Navigate to "Maintain Permissions for Security Group".
Step 2: Select the newly created group.
Step 3: Add the required permissions. For read-only access, select "Get Only". For read and write access, select "Get and Put".
Step 4: Select all the required permissions.
API Operation | Domain Security Policy |
|---|---|
Get Only | Worker Data: Public Worker Reports |
Get Only | Person Data: Name |
Get Only | Person Data: Personal Data |
Get Only | Person Data: Home Contact Information |
Get Only | Person Data: Work Contact Information |
Get Only | Worker Data: Compensation |
Get Only | Worker Data: Workers |
Get Only | Worker Data: All Positions |
Get Only | Worker Data: Current Staffing Information This is required to surface Employment Status of Employees |
Get Only | Worker Data: Employment Data |
Get Only | Worker Data: All Worker’s Positions Past and Present This is required to pull Historical Employments |
Get Only | Worker Data: Organization Information |
Get Only | Reports: Pay Calculation Results for Worker (Results) |
Get Only | Worker Data: Payroll |
Get Only | Integration Build This is required to pull Payroll |
Get Only | Worker Data: Time Off |
Get Only | Set Up: Benefits |
Get Only | Process: Export Time Blocks |
Get Only | Worker Data: Time Off (Accrual and Time Off Adjustments/Overrides by Batch ID) |
Get Only | Worker Data: Benefit Elections |
Get Only | Worker Data: Beneficiaries and Dependents |
Get Only | Worker Data : Compensation by Organization |
Step 5: [Optional] For employee write, also add the following permissions:
API Operation | Domain Security Policy |
|---|---|
Get Only | Job Requisition Data |
Get and Put | Pre Hire: Personal Data |
Get and Put | Person Data: Personal Information |
Step 6: Press okay and done.
Main Domain | Subdomain |
|---|---|
Job Requisition Data | |
Person Data: Personal Data | Person Data: Citizenship Status Person Data: Disabilities Person Data: ID Information Person Data: National ID Identification Person Data: Marital Status Person Data: Date of Birth Person Data: Gender Person Data: Government IDs Person Data: Personal Information Person Data: Photo |
Person Data: Home Contact Information | Person Data: Home Address Person Data: Home Email Person Data: Home Instant Messenger Person Data: Home Phone Person Data: Home Web Address |
Person Data: Work Contact Information | Person Data: Work Address Person Data: Work Email Person Data: Private Work Email Integration Person Data: Work Instant Messenger Person Data: Work Phone Person Data: Work Web Address |
Worker Data: Workers | |
Worker Data: Compensation - All Worker’s Positions Past and Present | |
Worker Data: All Positions | |
Worker Data: Current Staffing Information | |
Worker Data: Public Worker Reports | |
Worker Data: Employment Data | |
Reports: Pay Calculation Results for Work (Results) | |
Worker Data: Payroll | |
Process: Export Time Blocks | |
Worker Data: Organization Information | |
Worker Data: Benefit Elections | |
Worker Data: Beneficiaries and Dependents | |
Worker Data: Time Off** | Worker Data: Time Off (Time Off) Worker Data: Time Off (Accrual and Time Off Adjustments/Overrides by Batch ID).- time off permission Worker Data: Time Off (Time Off Balances) Worker Data: Time Off (Time Off Balances Manager View) Worker Data: Time Off (Time Off Manager View) |
Activate All Changes
Step 1: Navigate to "Activate Pending Security Policy Changes".
Step 2: Add a comment and then confirm.
Setting up the Connection
Step 1: Enter the User ID and Password created earlier and click Next.
Step 2: To find your Workday web services endpoint URL, return to your Workday dashboard. Search for Public Web Services
Step 3: Navigate to Benefit Administration > Web Service > View WSDL. Scroll to the bottom, and copy everything before "/service" in the URL.
Step 4: Return to Magic Link, paste the copied URL, and click Next.
Step 5: To find your Workday tenant name, look at your dashboard’s URL, and copy the part after "workday.com."
Step 6: Paste the tenant name in the provided field.
Enter Your Integration System ID (optional)
Note: This step is required only if you want to use Workday custom/calculated fields. You can skip it if they are not needed.
Create an Integration System if you have not already. You can follow this guide: Add Custom/Calculated Field.
Go to your Workday dashboard and search for View Integration System.
Open View Integration System.
Select the Integration System created in step 1.
Click on the System ID.
You will now see the ID that needs to be passed.
Select the System ID and paste it here.
Click on 'Connect' to proceed.
You have successfully connected to Workday!