Skip to main content

Workday Integration Guide for CRAs

Evan Nelson avatar
Written by Evan Nelson
Updated over 2 months ago

Overview

The Workday integration with deverus is a standardized connection designed to facilitate background check processing within Workday Recruiting. This integration was developed with guidance from Workday technical support and follows Workday's best practices. Clients must work with a Workday consultant to complete required configurations.


Timeline

Estimated Time to Configure:

  • Configuration by Workday Consultant: Varies based on Workday consultant

  • IM Account Configuration: 1-2 business days after credentials are received

Expected Go-Live Timeline:

  • Once all requirements are met, the typical go-live time is 4-8 weeks, including testing and validation.


Integration Connection Pricing

1. Self-Service Integration (No Cost): Clients or their representatives, including Workday consultants, can independently set up Workday integrations without incurring additional charges.

We continue to provide comprehensive resources for self-implementation:

  • Detailed integration documentation

  • Step-by-step implementation guides

  • Access to our knowledge base

These resources remain completely free and are sufficient for most standard integration scenarios.

2. Premium 14-Day Support Package ($2,250): During this period, clients can benefit from unlimited support for addressing integration concerns and implementing assistance.

For situations requiring direct assistance from our team, we offer a 14-day support package:

  • Direct access to our integration specialists

  • Technical troubleshooting and guidance

  • Implementation assistance

  • Configuration help

  • Testing support


Integration Requirements

Prerequisites for Setup

  • Partnership with Workday: Not required

  • Workday Consultant Required: Yes - it is strongly recommended that the consultant is well-versed in permissions, security protocols, and custom configuration requirements.

  • deverus: Integration Manager (IM) configuration (completed by CRA, or deverus with SOW)

  • SwiftHire Mobile: Required

  • Authentication Method: Workday API (Web Service Calls)

  • Workday Recruiting Module

Required Information for Setup

The consultant must provide the following details:

  • Workday API Credentials

    • API Username

    • API Password

    • Tenant Name

    • Host Name (Important Note: The Host Name is not the full URL the Workday consultant may provide. Instead, it is a portion of it, such as services1.myworkday.com.)

  • Workday Configurations Completed by Workday Consultant:

    • Get_Candidates

    • Get_Applicants

    • Get_Job_Requisitions

    • Put_Background_Check

    • Get_Workers

    • Workday Recruiting Web Service Endpoint URL

    • Package configuration using ID values provided by CRA

    • Location configuration using ID values created by Workday


Project Steps

  1. CRA provides the Workday Configuration Guide and Security Permissions Spreadsheet, along with package and location details, to the client’s Workday Consultant.

  2. Workday Consultant completes necessary configuration work within Workday.

  3. Workday Consultant provides the required credentials (API Username, API Password, Tenant Name, Host Name, Package IDs, and Location IDs) to CRA.

  4. CRA configures the account in Integration Manager using the provided credentials.

  5. Roundtrip testing.


Integration Manager (IM) Configuration Steps

Steps for CRA or deverus Integration Team

Note: Please wait to configure the account in Integration Manager until you have all of the required API credentials.

  1. Login to deverus -> Integration tab -> Home

  2. Select the Workday tile

  3. Select "Configure Existing Client"

  4. Type in the name of the top/parent client account and select it

  5. Choose the Send Results option:

    • Report Link with Login (the result URL in Workday for the completed report will prompt the user to enter their deverus login credentials to view report)

    • Report Link without Login (the result URL in Workday for the completed report will bring the user directly to a copy of the report)

  6. Toggle SwiftHire to On

  7. Click Next

  8. Enter Workday API credentials provided by the consultant:

    • API Username

    • API Password

    • Tenant Name

    • Host Name (Important Note: Ensure the host name follows the correct format, e.g., services1.myworkday.com, and is not the full URL.)

    • ('Include Job Title on Report' can remain empty)

  9. Click 'Save'

  10. Map Package(s)

    • Locate the account you just configured in IM

    • Navigate to "Map Fields"

    • Enter the appropriate package value in to the Integrations Partner Package ID field (Workday will often use the deverus packageID for this)

    • Save Mappings

  11. Map Location(s)

    • Locate the account you just configured in IM

    • Navigate to "Map Fields"

    • Enter Workday's LocationID value in the Integrations Partner Location ID field (these are usually created by Workday)

    • Save Mappings

  12. Test the Integration

    • Have the consultant submit a test order and verify status updates

    • Ensure applicant statuses (Pending Candidate, Pending, Complete) flow correctly between Workday and deverus


Special Notes & Considerations

  • Client or consultant must notify CRA before making any environment changes in Workday (e.g., moving the client from their Testing tenant to the Production tenant), as the new credentials will need to be saved in IM.

  • Common Issues & Fixes:

    • "Bad Package ID" error → Ensure package is mapped correctly in Workday and IM

    • "Bad Location ID" error → Confirm Workday Location ID matches IM Location ID


Guides & Documentation

  • deverus Workday Integration Configuration Guide

  • deverus Workday Integration System Security Group Permissions

  • Troubleshooting Common Errors: [Article HERE]

Did this answer your question?