Skip to main content
Documentation
Documentation
Peakon
Last Updated: 2026-02-20
Connect to Workday Using OAuth

Connect to Workday Using OAuth

In Workday, create these integration items:
  • Integration Security
     domain in the Integration functional area.
  • Integration system user.
  • Integration system security group.
Security:
Administrator
 access in Peakon.
You can connect Peakon to Workday and authenticate transferred data using OAuth.
We recommend that you Connect to Workday Using ISU Name and Password, which is easier to set up and is less prone to disconnection due to external factors.
  1. In Workday, access the
    Edit Tenant Setup – Security
     task.
  2. Select the
    OAuth 2.0 Clients Enabled
     check box.
  3. While still in Workday, access the
    Register API Client
     task.
  4. Enter the
    Client Name
     and select
    Authorization Code Grant
    .
  5. Select
    Bearer
     as the
    Access Token Type
     and enter the
    Redirection URL
    .
    The redirection URL format is
    https://companyname.peakon.com/workday/complete
    . You must substitute
    companyname.peakon.com
     for your custom subdomain.
  6. Select the
    Non-Expiring Refresh Tokens
     check box.
  7. Select these functional areas from the
    Scope (Functional Areas)
     prompt:
    • Contact Information
    • Implementation
    • Personal Data
    • Public Data
    • Staffing
    • System
  8. Click
    OK
    .
  9. Collect the
    Tenant
    ,
    Webservice Host
    ,
    Client ID
    ,
    Client Secret
    , and
    Auth Host
     values.
    The
    Workday REST API Endpoint
     contains the
    Webservice Host
     and the
    Tenant
    . Example: When the endpoint is
    https://wd3-services1.myworkday.com/api/v1/tenant_name
    , then the
    Webservice Host
     is
    wd3-services1.myworkday.com
     and the
    Tenant
     is
    tenant_name
    .
    The
    Authorization Endpoint
     contains the
    Auth Host
    . Example: When the authorization endpoint is
    https://wd3.myworkday.com/tenant_name/authorize
    , the
    Auth Host
     is
    wd3.myworkday.com
    .
    Workday labels
    Client ID
     and
    Client Secret
    accordingly.
    Take note of the
    Client Secret
     value, because it’s not possible to recover it after closing this page. It’s required in the event of a disconnection.
  10. Open Workday in an incognito window to sign in as a Peakon integration system user (ISU).
    When your company uses SSO to sign in to your Workday tenants, use this URL template to sign in to Workday as the Peakon ISU: (https://<workdayDomain>/wday/authgwy/<tenant>/login.htmld?redirect=n). <workdayDomain> is your Workday tenant domain and <tenant> is your Workday tenant name.
    Signing in through an incognito window ensures that the integration doesn’t connect with the wrong credentials for the Workday tenant, which would cause syncing issues.
  11. In Peakon, go to
    Administration
    Integrations
    Workday
    .
  12. Select
    OAuth
     from the
    Authentication mode
     prompt.
  13. Enter the values from Step 9 in these fields:
    • Tenant
    • Webservice Host
    • Client ID
    • Client Secret
    • Auth Host
  14. Click
    Connect
    .
    The sync is now active and will run automatically. If you need to prevent this from happening while still being able to continue the setup in Step 17, click
    Disable
    .
  15. (Optional) On the sign-in page, sign in as ISU.
  16. Click
    Allow
    .
  17. Configure the settings that now display on the Workday integration page on Peakon.
    Some of the options require additional domain security access. See Set Up Domains in Security Group for Workday Integration.
    Option
    Description
    Integration System ID
    (Optional) Fill in this field if you need to create field overrides to transfer custom fields or use the
    PEAKON_INCLUDED
     functionality.
    Organization ID
    (Optional) Fill in this field to filter by employees by organization. To sync employees in multiple organizations, separate the organization IDs by a single space. When you enter an Organization ID to filter, we include subordinate organizations automatically.
    We recommend using this instead of the
    PEAKON_INCLUDED
     functionality when filtering by organizations, because:
    • Configuring the
      PEAKON_INCLUDED
       functionality in a way that mirrors the
      Organization ID
       field is difficult to achieve correctly, and the sync may therefore not deliver the intended result.
    • It works faster than the
      PEAKON_INCLUDED
       functionality.
    Time zone
    (Optional) Select this option to sync local employee time zones. Peakon will send a survey to employees in their local time zone.
    Locale
    (Optional) Select this option to sync local employee languages. Peakon will use the synced languages in employee survey communications, if those languages are enabled in your organization’s survey settings.
    Phone number
    (Optional) Select this option to reveal employee phone number sync options.
    • Work
    • Home
    • Sync private numbers
    Syncing phone numbers is useful if you want to send survey notifications using SMS.
    When you select both
    Work
     and
    Home
     numbers, the
    Primary Work
     phone number takes precedence.
    Include specific employees - Based on custom criteria set in Workday
    (Optional) Select this option to only sync certain groups of employees.
    In addition to enabling this checkbox, create a
    PEAKON_INCLUDED
     field override entry in the
    Field Override Service
    . The source override must be a boolean calculated field that returns
    True
     for employees that you wish to include.
    Include specific employees - Contingent workers
    (Optional) Select this option to also include contingent workers.
    Map by external ID (only if data doesn't contain duplicate segments)
    (Optional) Select this option to match external IDs with segments when you map attributes from Workday to Peakon.
    This feature enables you to use more advanced attribute mapping when you don’t have duplicated segments.
    Workday maps the segment external IDs of these attributes to Peakon:
    • Department
    • Employment Type
    • Gender
    • Job Family
    • Management Level
    • Separation Reason
    Workday doesn't map the external ID when there's a field override for the attribute.
    Workday doesn't create a new segment in Peakon when a segment name changes in Workday. Example: When, in Workday, you change the name of the
    Benefits EMEA Region
     segment to
    Benefits Global
    , Peakon automatically updates the existing
    Benefits EMEA Region
     segment name to
    Benefits Global
    .
    When segments contain duplicate names, Peakon doesn't sync the segment for the impacted employees and, instead, displays an error message
Perform a full sync by clicking
Sync all
 in
Administration
Integrations
Workday
.
After the initial full sync, Peakon will sync any future changes incrementally every hour, however it's possible to initiate a full sync manually.
You can use the
Export to CSV
 button on integration audits to export the latest 5,000 records of integration event audit logs in CSV format.