---
sourceDocument: Brazil Workflow Data Fabric
sourceDocumentLink: https://www.servicenow.com/docs/r/integrate-applications

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# Configurations to use Workday REST API

# Configurations to use Workday REST
API {#ariaid-title1}

Release version: Brazil  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 minutes to read  
Configure your ServiceNow instance to perform actions that
use the Workday REST
API.

## Before you begin

* Request an Integration Hub subscription.
* Activate Workday HR spoke.
* From Workday, obtain these values and record them for later use. These values are need to register your client:
  * Client ID
  * Client Secret
  * Workday REST API Endpoint
  * Token Endpoint
  * Authorization Endpoint
  {#rest-wd-hr-spoke__ul_abb_dnh_3xb}
* Role required: admin
{#rest-wd-hr-spoke__ul_agy_qxd_rd3}

## About this task

Workday REST and
Report-as-a-Service (RAAS) API works with OAuth 2.0 to authorize access to resources in
your Workday tenant. To
use OAuth 2.0, you must register your client in the tenant, using the Register API
Client task.  
Configure your ServiceNow instance to use the Workday REST API if you need to use these REST-based spoke actions:

* Download Workday RAAS CSV
* Get Access Token (Metadata)
* Look up Data Source
* Look up Data Source Field
* Look up Data Source Filter
* Look up Employee Goals
* Look up Employee Latest Performance Review
* Look up Employee Performance Review Historical Data
* Look up Employee Skills
* Look up Feedback Received
* Look up In-Progress Approval Requests
* Look up Skills
* Look up Succession Planning
* Look up Succession Pool
* Look up Termination Details
* Look up Worker Job History Report
* Look up Worker Time Off And Leave Of Absence Request
* Look up Data Source Fields Stream
* Look up Data Source Filters Stream
* Look up Data Sources Stream
* Get My Reporting Structure
* Look up Object Custom Fields
* Update Object Custom Fields
* Look up Payslip
* Look up Total Rewards Using Report
* Look up Custom Reports
* Look up Inbox Items
* Look up Merit And Benefit Plan Details Of An Employee
* Look up Holiday Calendars Reference WID Of An Employee
* Look up Schedule Calendars Reference WID Of An Employee
* Look up Holiday Calendars Of An Employee
* Look up using WQL Stream

{#rest-wd-hr-spoke__rest-actions}  
Note:  
These configurations are needed to use the REST-based spoke actions.

## Register Workday HR
as an OAuth provider {#ariaid-title2}


Register the Workday HR instance as
the OAuth provider so that the ServiceNow instance can request OAuth
2.0 tokens.

### Before you begin

Role required: admin

### Procedure

1. Navigate to AllSystem OAuthApplication Registry.
2. Click New.  
   The system displays this message: What kind of OAuth application?.
3. Select Connect to a third party OAuth Provider.
4. On the form, fill these values.  
   {#reg-wd-hr-spoke__table_wr3_byh_pmb__entry__2}

   | Field | Description |
   |-|-|
   | Name | Name to uniquely identify the record. For example, enter: <kbd class="ph userinput">Workday HR OAuth</kbd> |
   | Application | Application in which the record is applicable. Select Workday HR Spoke. |
   | Client ID | Client ID generated while registering your client. |
   | Client Secret | Client secret generated while registering your client. |
   | Authorization URL | Authorization endpoint generated while registering your client. |
   | Token URL | Token endpoint generated while registering your client. |
   | Redirect URL | OAuth callback endpoint in this format: <kbd class="ph userinput">https://&lt;instance&gt;.service-now.com/oauth_redirect.do</kbd> |
   | Default Grant Type | Grant type used to establish the token. Select Authorization Code. |
   | Active | Option to actively use the application registry. |
   [Table 1. Application Registries form]

   {#reg-wd-hr-spoke__table_wr3_byh_pmb}
5. Right-click the form header, and click Save.  
   An OAuth entity profile is created.
{#reg-wd-hr-spoke__steps_vr3_byh_pmb}

## Generate token URL for Workday HR spoke {#ariaid-title3}

Register API client in your Workday account and generate a token URL for Workday HR spoke.

### Before you begin

Role required: admin

### Procedure

1. Log into your Workday tenant.
2. Navigate to Search and enter <kbd class="ph userinput">Register API Client</kbd> task.
3. On the Register API Client, fill in the details.  
   {#gen-token-url-wkday-hr-spoke__table_is5_wxm_2yb__entry__2}

   | Field | Description |
   |-|-|
   | Client Name | Client name of the app. For example, <kbd class="ph userinput">Workday HR spoke</kbd>. |
   | Client Grant Type | Select Authorisation Code Grant. |
   | Access Token Type | Access Token Type: Select Bearer |
   | Redirection URI | Enter your ServiceNow URL in this format: <kbd class="ph userinput">https://&lt;instance&gt;.service-now.com/oauth_redirect.do</kbd>. |
   | Non-Expiring Refresh tokens | Option to enable refresh tokens which do not expire. |
   | Scope (Functional Areas) | Select the required functional areas. |
   | Include Workday Owned Scope | Option to select scope that are owned by Workday. |
   [ ]

   {#gen-token-url-wkday-hr-spoke__table_is5_wxm_2yb}
4. Click OK.

### Result

Copy and store the generated Token Endpoint value for configuring system property.

## Option 1: Configuration to use Workday HR REST API with a template {#ariaid-title4}

Configure your ServiceNow instance to perform actions that use the Workday HR REST API using an OAuth authorization template.

### Before you begin

Role required: admin

### Configure a connection for Workday HR REST API {#ariaid-title5}

Add and configure a Workday HR REST API connection to authenticate ServiceNow requests in Workday HR spoke.

#### Before you begin

* Role required: admin
* [Register Workday HR as an OAuth provider](https://www.servicenow.com/docs/cYYUe5VNsLxoEDL6shagmQ#reg-wd-hr-spoke "Register the Workday HR instance as the OAuth provider so that the ServiceNow instance can request OAuth 2.0 tokens.")
{#config-connection-workday-hr-spoke__ul_czs_xtx_yhc}

#### Procedure

1. Navigate to AllProcess AutomationWorkflow Studio.
2. Select Integrations.
3. Select the Connections tab.
4. Use the search box to find the WorkdayHR connection alias.
5. Click View Details.  
6. Configure a cloud connection.  
   1. Add or edit a cloud connection.
      * To set up an existing connection, select Configure or Edit.
      * To create and configure a new connection, select Add Connection.
      {#config-connection-workday-hr-spoke__ul_vln_13j_yhc}
   2. On the configuration form, fill in the fields.

   {#config-connection-workday-hr-spoke__ol_osc_zhj_yhc} {#config-connection-workday-hr-spoke__table_workday_hr_conn_config__entry__2}

   | Field | Description |
   |-|-|
   | Name | Name to uniquely identify the connection. For example, <kbd class="ph userinput">Workday HR spoke connection</kbd>. |
   | Connection URL | URL to make a connection to Workday HR. Use this format: <kbd class="ph userinput">https://&lt;workday_host&gt;/ccx/service/&lt;tenant_name&gt;</kbd> |
   | Tenant Name | Name of the Workday tenant. For example, <kbd class="ph userinput">bcone_gms1</kbd>. |
   | API Version | Version of the Workday API to use for requests. |
   | Client ID | Client ID generated in Workday for OAuth authentication. |
   | Client Secret | Client Secret generated in Workday for OAuth authentication. |
   | Authorization URL | URL used to authorize the OAuth connection. Use this format: <kbd class="ph userinput">https://&lt;workday_host&gt;/authorize</kbd> |
   | Token URL | URL used to generate the OAuth token. Use this format: <kbd class="ph userinput">https://&lt;workday_host&gt;/token</kbd> |
   | OAuth Redirect URL | URL where Workday redirects after successful authentication. Use this format: <kbd class="ph userinput">https://&lt;instance_name&gt;.service-now.com/oauth_redirect.do</kbd> |
   [Table 2. Configuration form]

   {#config-connection-workday-hr-spoke__table_workday_hr_conn_config}
7. Click Save and Get OAuth Token.

#### Result

The spoke connection is configured and ready to be used.

## Option 2: Configuration to use Workday HR REST API without a Template {#ariaid-title6}

Configure your ServiceNow instance to perform actions that use the Workday HR REST API by manually creating connection and credential records.

### Before you begin

Role required: admin

### Create a credential record for the Workday HR
spoke {#ariaid-title7}

Create a credential record for the Workday HR instance.
The Workday HR spoke
connection and credential alias uses these credentials to authorize actions.

#### Before you begin

Role required: admin.

#### Procedure

1. Navigate to AllConnections \& CredentialsCredentials.
2. Click New.  
   The system displays this message: What type of Credentials would you like to create?
3. Select OAuth 2.0 Credentials.
4. On the form, fill these values.  
   {#create-cred-wd-hr-spoke__table_asb_cxh_pmb__entry__2}

   | Field | Description |
   |-|-|
   | Name | Name to uniquely identify the record. For example, <kbd class="ph userinput">Workday HR Cred</kbd>. |
   | Active | Option to actively use the credential record. |
   | OAuth Entity Profile | OAuth entity profile created during the registration of Workday HR as an OAuth provider. For example, OAuth Profile. |
   [Table 3. OAuth 2.0 Credentials form]

   {#create-cred-wd-hr-spoke__table_asb_cxh_pmb}
5. Right-click the form header and click Submit.
6. To generate the OAuth token, click the Get OAuth Token related link.
{#create-cred-wd-hr-spoke__steps_ngm_qvh_pmb}

### Create a connection record for the Workday HR spoke {#ariaid-title8}

Create a connection record for your Workday HR instance.
The Workday HR spoke connection and credential aliases use these connections to
perform actions in Workday HR.

#### Before you begin

Role required: admin.

#### Procedure

1. Navigate to AllConnections \& CredentialsConnections \& Credentials Aliases.
2. Open the alias record, WorkdayHR.
3. From the Connections tab, click New.
4. On the form, fill these fields.  
   Note:  
   Ensure that you create the connection record in the Workday HR Spoke application.
   {#conn-wd-hr-spoke__table_o43_513_pmb__entry__2}

   | Field | Description |
   |-|-|
   | Name | Name to uniquely identify the record. For example, <kbd class="ph userinput">Workday HR Connection</kbd>. |
   | Credential | Credential record created for Workday HR spoke. For example, <kbd class="ph userinput">Workday HR Cred</kbd>. |
   | Connection alias | Alias record associated with this connection. |
   | Connection URL | URL to connect to your Workday HR instance. |
   | Active | Option to actively use the connection record. |
   [Table 4. Connection form]

   {#conn-wd-hr-spoke__table_o43_513_pmb}
5. In the Attributes tab, fill in these values.  
   {#conn-wd-hr-spoke__table_atc_4sd_rmb__entry__2}

   | Field | Value |
   |-|-|
   | Tenant Name | Tenant name of your Workday application. |
   | Version | v1 |
   [ ]

   {#conn-wd-hr-spoke__table_atc_4sd_rmb}
6. Click Submit.
{#conn-wd-hr-spoke__steps_n43_513_pmb}

*[\>]: and then