Workday
Watch the tutorial
Overview
The Workday connector enables your Leena AI Agents to integrate with your organization's Workday platform, facilitating automated HR workflows, employee data management, time-off requests, business process approvals, case management, and more.
Workday is a leading cloud-based human capital management (HCM) and financial management system used by large enterprises to manage their workforce, including employee profiles, payroll, timesheets, benefits, compensation, and talent. The Workday connector allows Leena AI to automate HR workflows, manage employee data, handle time-off requests, process business approvals, and interact with Workday seamlessly.
API Details
Leena AI integrates with Workday via REST APIs and SOAP Web Services.
Documentation link: https://community.workday.com/sites/default/files/file-hosting/restapi/
Setup
The Workday connector supports three authentication methods: Workday OAuth 2.0 (refresh token grant type), Workday REST User OAuth 2.0 (authorization code grant type with per-user sign-in), and Workday REST Basic Authentication.
Prerequisites
Before setting up the Workday connector, ensure you have:
- Administrator or Integration-enabled user access to your Workday tenant
- An Integration System User (ISU) configured in Workday with appropriate domain security permissions
- An Integration System Security Group (Unconstrained) with the ISU bound to it
- OAuth 2.0 Clients enabled in your Workday tenant (Edit Tenant Setup – Security) — required for OAuth-based authentication methods
- Access to your Leena AI workspace with connector management permissions
Get credentials
Here is how to register an API Client and configure OAuth 2.0 in Workday:
- Log in to your Workday tenant (Ensure you're signed in as an admin or integration-enabled user).
- Enable OAuth 2.0 on the Tenant:
- Search for "Edit Tenant Setup – Security" in the Workday search bar
- Scroll down to the OAuth 2.0 Settings section
- Check the "OAuth 2.0 Clients Enabled" checkbox
- Save the configuration
- Create an Integration System User (ISU):
- Search for "Create Integration System User" in the Workday search bar
- Enter a username and set a password
- Set Session Timeout Minutes to 0 to prevent the ISU from timing out
- Assign the ISU to an Integration System Security Group with the required domain security policies
- Register an API Client:
- Search for "Register API Client for Integrations" in the Workday search bar
- Client Name: Enter a descriptive name for your API client (e.g., "Leena AI Integration")
- Non-Expiring Refresh Tokens: Check this option
- Scope (Functional Areas): Select the required functional areas for your integration use cases (e.g., Staffing, Human Resources, Absence Management, Time Tracking, Benefits, etc.)
- Click OK to complete registration
- Save Credentials:
- Copy the Client ID and Client Secret immediately (The Client Secret is displayed only once)
- Note the Authorization Endpoint, Token Endpoint, and Workday REST API Endpoint from the registration summary
- Generate a Refresh Token (required for Workday OAuth 2.0 auth type):
- Search for "View API Clients" in Workday
- Navigate to the "API Clients for Integrations" tab
- Select the API client you registered
- Click the ellipsis (...) → API Client → Manage Refresh Tokens for Integrations
- Enter the Workday Account (ISU) in the Workday Account field
- Under "Delete or Regenerate Refresh Token," select "Generate New Refresh Token"
- Copy and securely store the generated Refresh Token
Add connection
Here is how to add a connection on Leena AI:
- Log in to your Leena AI workspace
- Navigate to Settings > Integrations
- Search for "Workday" and select it from the list to add its new connector
- Select the Auth Type and start configuring the connector based on the chosen authentication method:
Option 1: Workday OAuth 2.0
This authentication method uses a refresh token grant type with a system-level Integration System User (ISU). It is suited for backend integrations where a single service account performs actions on behalf of all users.
- Auth Type: Select "Workday OAuth 2.0"
- Base URL: Your Workday instance base URL (e.g.,
https://wd3.myworkday.com) - Tenant ID: Your Workday tenant identifier (found in your Workday URL, e.g.,
your_company) - Client ID: The API Client ID from Workday registration
- Client Secret: The API Client Secret from Workday registration
- Refresh Token: The non-expiring refresh token generated in Workday
Option 2: Workday REST User OAuth 2.0
This authentication method uses an authorization code grant type where each individual employee signs in with their own Workday credentials. It is suited for use cases where actions need to be performed in the context of the logged-in user (e.g., the user's own time-off requests, inbox tasks, or approvals). Leena AI automatically manages per-user token storage, refresh, and worker ID resolution.
- Auth Type: Select "Workday REST User OAuth 2.0"
- Redirect URI: Auto-generated by Leena AI (Copy this and add it to the Authorized redirect URIs in your Workday API Client configuration)
- Base URL: Your Workday instance base URL (e.g.,
https://wd3.myworkday.com) - Auth URL: The Workday Authorization Endpoint URL (e.g.,
https://wd3.myworkday.com/your_company/authorize) - Tenant ID: Your Workday tenant identifier
- Client ID: The API Client ID from Workday registration
- Client Secret: The API Client Secret from Workday registration
Once configured, individual users will be prompted to sign in via a Workday authorization page when they first interact with the connector. Upon granting access, Leena AI securely stores their OAuth tokens and automatically refreshes them as needed.
Option 3: Workday REST Basic Authentication
This authentication method uses username and password credentials. It is suited for simpler setups or environments where OAuth 2.0 is not required.
- Auth Type: Select "Workday REST Basic Authentication"
- Base URL: Your Workday instance base URL (e.g.,
https://wd3.myworkday.com) - Tenant ID: Your Workday tenant identifier
- Username: The ISU username configured in Workday
- Password: The ISU password
Save Configurations
- Complete Setup and Save
- Click Save/Connect in Leena AI for the Workday connector setup
- The connector will validate the credentials (by obtaining an access token for OAuth methods, or verifying credentials for Basic Auth)
- Upon successful validation, the connector will be saved and active
- Update Workday API Client (for User OAuth 2.0 only):
- Once the connector is saved in Leena AI, reopen the connector to view the Redirect URI
- Copy the Redirect URI from Leena AI
- Go back to Workday → Register API Client for Integrations → Edit your API Client
- Add the Redirect URI to the Authorized redirect URIs
- Save the changes in Workday
Actions
The following actions are supported for the Workday connector:
Get Workers
Retrieves worker information from Workday. The Agent can leverage this action to look up worker details, which serves as a foundational step for many other actions that require a Worker ID.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker ID | The unique identifier of the worker |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns worker details including:
- Worker ID
- Person ID
- Worker profile information
Get Balances
Retrieves time-off balances for a worker from Workday. The Agent can leverage this action to check an employee's available leave entitlement across different time-off plans. Here are some common use cases:
- Leave Planning: Check remaining vacation days before requesting time off
- Manager Review: View team members' leave balances
- Year-End Review: Assess unused leave balances
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
Optional
| Name | Description |
|---|---|
| Effective | Effective date for the balance calculation |
| Category | Category filter for specific balance types |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of time-off balances, each containing:
- Plan name
- Balance amount
- Unit of measure
- As-of date
Get Eligible Absence Type
Retrieves the list of absence/leave types that a worker is eligible for. The Agent can leverage this action to dynamically present employees with the correct leave categories when submitting a time-off request.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
Optional
| Name | Description |
|---|---|
| Category | Filter by absence category (e.g., Time Off, Leave of Absence) |
| Effective | Effective date for eligibility check |
Response
The action returns a list of eligible absence types, each containing:
- Absence type ID
- Absence type name
- Category
Request Timeoff
Submits a time-off request in Workday on behalf of a worker. The Agent can leverage the skill (workflow), which has been designed to create a new time-off request in Workday, once the user raises a query to do so. This action supports attaching supporting documents (e.g., a doctor's note) to the request. Here are some common use cases:
- Vacation Request: Submit a request for planned leave
- Sick Leave: Request sick leave with optional medical certificate attachment
- Personal Day: Request a personal day off
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee requesting time off |
| Dates | Array of date strings for the requested days off |
| Time Off Type ID | The ID of the absence type being requested |
Optional
Name | Description |
|---|---|
Comment | A comment or reason for the time-off request |
Attachments | Array of supporting documents to attach, each containing:
|
Response
Upon successful submission, the action returns:
- Request status (e.g., 202 Accepted)
- Time-off request ID
- Business process event ID
Get Timeoff details
Retrieves a comprehensive absence history for a worker from Workday. The Agent can leverage this action to show an employee their past and pending time-off requests with detailed filtering options. Here are some common use cases:
- Absence History: View past leave records within a date range
- Pending Requests: Check the status of submitted requests
- Leave Type Review: Filter absences by specific leave type
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
Optional
| Name | Description |
|---|---|
| From Date | Start date for filtering absence records |
| To Date | End date for filtering absence records |
| Status | Filter by request status (e.g., Approved, Pending) |
| Time Off Type | Filter by specific leave type |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of time-off entries, each containing:
- Time-off entry ID
- Dates requested
- Time-off type
- Status (Approved, Pending, Denied)
- Duration
- Comments
Get timeoff entries of a worker
Retrieves a list of time-off entries for a worker. This provides an alternative view to "Get Timeoff details" with basic pagination support.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of time-off entries with summary details.
Get individual time off entries of a worker
Retrieves a single, specific time-off entry by its unique identifier.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
| Subresource ID | The unique identifier of the time-off entry |
Response
The action returns the full details of the specified time-off entry.
Get timeoff plans of a worker
Retrieves all time-off plans that a worker is enrolled in.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of time-off plans the worker is enrolled in, including plan name, type, and balance information.
Get individual time off plans of a worker
Retrieves the details of a single, specific time-off plan by its unique identifier.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
| Subresource ID | The unique identifier of the time-off plan |
Response
The action returns the full details of the specified time-off plan.
Get Holiday Events
Retrieves company holiday events from Workday. The Agent can leverage this action to show employees the holiday calendar for their location, helping them plan time-off requests. Here are some common use cases:
- Holiday Calendar: Display upcoming company holidays
- Leave Planning: Help employees plan leave around public holidays
- Location-Specific Holidays: Retrieve holidays based on employee location
Input Parameters
Here are the input parameters required to set up this action:
Optional
| Name | Description |
|---|---|
| Worker | The Worker ID to get location-specific holidays |
| From Date | Start date for filtering holiday events |
| To Date | End date for filtering holiday events |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of holiday events, each containing:
- Holiday name
- Holiday date
- Holiday type
Retrieve Business Process Events (/events)
Retrieves a list of business process events from Workday. The Agent can leverage this action to view ongoing workflows such as time-off requests, job requisitions, and performance reviews. Here are some common use cases:
- Pending Approvals: View all pending approval requests
- Workflow Monitoring: Track the status of ongoing business processes
- Team Management: Review submitted requests for direct reports
Input Parameters
Here are the input parameters required to set up this action:
Optional
| Name | Description |
|---|---|
| Business Process | Filter by type of business process |
| Worker | Filter events by a specific worker |
| Status | Filter by event status (e.g., In Progress, Completed) |
| From Date | Start date for filtering events |
| To Date | End date for filtering events |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of business process events, each containing:
- Event ID
- Business process type
- Status
- Initiated date
- Worker information
- Current step details
Retrieve Single Business Process Events
Retrieves the full details of a single business process event by its ID.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Event ID | The unique identifier of the business process event |
Response
The action returns the complete details of the specified business process event.
Get Event Step (of all business processes)
Retrieves a list of event steps across all business processes, with filtering options.
Input Parameters
Here are the input parameters required to set up this action:
Optional
| Name | Description |
|---|---|
| Business Process | Filter by type of business process |
| Worker | Filter steps by a specific worker |
| Status | Filter by step status |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of event steps with their status and associated event details.
Retrieve business process steps
Retrieves the steps for a specific business process event, categorised by their status. Here are some common use cases:
- Progress Tracking: View completed, in-progress, and remaining steps
- Bottleneck Identification: Find where a process is stalled
- Audit Trail: Review the step history of a completed process
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Event ID | The unique identifier of the business process event |
Optional
Name | Description |
|---|---|
Type | Filter by step status, options:
|
Limit | Maximum number of results to return |
Offset | Number of results to skip for pagination |
Response
The action returns a list of steps for the specified event, each containing:
- Step ID
- Step name
- Status (Completed, In Progress, Remaining)
- Assigned to
- Completion date (if applicable)
Get Individual Business Process event step
Retrieves the details of a single business process event step by its ID.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Step ID | The unique identifier of the event step |
Response
The action returns the complete details of the specified event step.
Retrieve Single Business Process Events Comments
Retrieves all comments associated with a specific business process event.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Event ID | The unique identifier of the business process event |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of comments with author, timestamp, and comment text.
Retrieve Single Business Process Events Attachments
Retrieves attachments associated with a specific business process event. This is useful for managers who need to review supporting documents before approving a request.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Event ID | The unique identifier of the business process event |
Response
The action returns a list of attachments with file names and download references.
Approve Individual Business Process event step
Approves a specific step in a business process workflow. The Agent can leverage the skill (workflow), which has been designed to approve a pending request in Workday, once the manager provides the step details. Here are some common use cases:
- Time-Off Approval: Approve an employee's leave request
- Job Requisition: Approve a new hire request
- Expense Approval: Approve expense reports
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Step ID | The unique identifier of the event step to be approved |
Optional
| Name | Description |
|---|---|
| Comment | An optional comment or note for the approval |
Response
Upon successful approval, the action returns:
- Confirmation of approval
- Updated step status
- Timestamp
Deny a Step
Denies a specific step in a business process workflow, effectively rejecting the request.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Step ID | The unique identifier of the event step to be denied |
Optional
| Name | Description |
|---|---|
| Comment | A comment explaining the reason for denial |
Response
Upon successful denial, the action returns:
- Confirmation of denial
- Updated step status
- Timestamp
Send back a Step
Sends a step back to a previous actor in the workflow for revision.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Step ID | The unique identifier of the event step to be sent back |
Optional
| Name | Description |
|---|---|
| Reason | A comment explaining why the step is being sent back |
| Send Back To ID | The ID of the person to whom the step should be returned |
Response
Upon successful send-back, the action returns:
- Confirmation of send-back
- Updated step status
- Timestamp
Cancel a business process event
Cancels an entire business process event that is no longer needed.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Event ID | The unique identifier of the business process event |
Optional
| Name | Description |
|---|---|
| Comment | A comment explaining the reason for cancellation |
Response
Upon successful cancellation, the action returns:
- Confirmation of cancellation
- Timestamp
Get inbox tasks of a worker
Retrieves all pending tasks in a worker's Workday inbox. The Agent can leverage this action to show a manager or employee their action items. Here are some common use cases:
- Pending Approvals: View all tasks awaiting action
- Task Overview: Get a consolidated view of inbox items
- Priority Management: Review and prioritise pending tasks
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of inbox tasks, each containing:
- Task ID
- Task title
- Task type
- Due date
- Status
- Related business process information
Get individual inbox task of a worker
Retrieves the details of a single inbox task by its ID.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
| Task ID | The unique identifier of the inbox task |
Response
The action returns the complete details of the specified inbox task.
Get direct reports of a worker
Retrieves a list of direct reports for a specific worker/manager.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the manager |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of direct reports with their worker details.
Get payslips of a worker
Retrieves a list of payslips for a worker.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of payslips with summary details.
Get individual payslip of a worker
Retrieves a single, specific payslip by its unique identifier.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
| Subresource ID | The unique identifier of the payslip |
Response
The action returns the full details of the specified payslip.
Get legal name of people
Retrieves the legal name of an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns the legal name details of the employee.
Get preferred name of people
Retrieves the preferred name of an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns the preferred name details of the employee.
Get additional names of people
Retrieves any additional names associated with an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns the additional name records of the employee.
Get personal information of people
Retrieves personal information of an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns personal details of the employee.
Get public contact information of people
Retrieves publicly available contact information of an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns public contact information of the employee.
Get photos of people
Retrieves the profile photos of an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns the employee's profile photo data.
Get home address of people
Retrieves the home address of an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Primary Only | Return only the primary home address |
| Public Only | Return only publicly visible addresses |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns the home address details of the employee.
Get home emails of people
Retrieves the home email addresses of an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Primary Only | Return only the primary home email |
| Public Only | Return only publicly visible emails |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns the home email addresses of the employee.
Get home phones of people
Retrieves the home phone numbers of an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Primary Only | Return only the primary home phone |
| Public Only | Return only publicly visible phones |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns the home phone numbers of the employee.
Get Work address of people
Retrieves the work address of an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Primary Only | Return only the primary work address |
| Public Only | Return only publicly visible addresses |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns the work address details of the employee.
Get work emails of people
Retrieves the work email addresses of an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Primary Only | Return only the primary work email |
| Public Only | Return only publicly visible emails |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns the work email addresses of the employee.
Get Work phones of people
Retrieves the work phone numbers of an employee from Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| ID | The Worker ID or Person ID of the employee |
| ID Type | Type of identifier being used (WORKER or PERSON) |
Optional
| Name | Description |
|---|---|
| Primary Only | Return only the primary work phone |
| Public Only | Return only publicly visible phones |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns the work phone numbers of the employee.
Update home address of people
Updates the home address for a worker in Workday. Supports bulk updates — multiple addresses can be added or modified in a single operation.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
| Addresses | Array of address objects to add or update |
Each address object includes fields such as address line, city, state/region, postal code, and country. If a subresourceID is provided, the existing address is updated; otherwise, a new address is created.
Response
Upon successful update, the action returns the status of each address update operation.
Update home emails of people
Updates the home email addresses for a worker in Workday. Supports bulk updates.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
| Emails | Array of email objects to add or update |
Response
Upon successful update, the action returns the status of each email update operation.
Update home phones of people
Updates the home phone numbers for a worker in Workday. Supports bulk updates.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
| Phones | Array of phone objects to add or update |
Response
Upon successful update, the action returns the status of each phone update operation.
Update work address of people
Updates the work address for a worker in Workday. Supports bulk updates.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
| Addresses | Array of address objects to add or update |
Response
Upon successful update, the action returns the status of each address update operation.
Update work emails of people
Updates the work email addresses for a worker in Workday. Supports bulk updates.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
| Emails | Array of email objects to add or update |
Response
Upon successful update, the action returns the status of each email update operation.
Update work phones of people
Updates the work phone numbers for a worker in Workday. Supports bulk updates.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Worker | The Worker ID of the employee |
| Phones | Array of phone objects to add or update |
Response
Upon successful update, the action returns the status of each phone update operation.
Get Cases
Retrieves a list of help desk or HR cases from Workday. The Agent can leverage this action to view and track employee cases. Here are some common use cases:
- Case Tracking: Monitor open cases and their progress
- Service Desk: View cases submitted by employees
- Reporting: Filter cases by type, status, or date range
Input Parameters
Here are the input parameters required to set up this action:
Optional
| Name | Description |
|---|---|
| Case Type | Filter cases by type |
| Status | Filter cases by status |
| Worker | Filter cases by a specific worker |
| From Date | Start date for filtering cases |
| To Date | End date for filtering cases |
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of cases with summary details including case ID, type, status, and created date.
Get Case by ID
Retrieves the details of a single case by its unique identifier.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Case ID | The unique identifier of the case |
Response
The action returns the complete details of the specified case.
Create Case
Creates a new help desk or HR case in Workday. The Agent can leverage this action to allow employees to submit new cases or requests. Here are some common use cases:
- HR Inquiry: Submit a question about benefits or policies
- IT Support: Log a technical issue
- Payroll Issue: Report a payroll discrepancy
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Case Type | The type/category of the case |
| Subject | The title or subject of the case |
Optional
| Name | Description |
|---|---|
| Description | Detailed description of the case |
| Worker | The Worker ID of the employee submitting the case |
| Priority | Priority level of the case |
Response
Upon successful creation, the action returns:
- Case ID
- Case status
- Creation timestamp
Update Case
Updates an existing case in Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Case ID | The unique identifier of the case |
Optional
| Name | Description |
|---|---|
| Status | Updated status for the case |
| Subject | Updated subject/title |
| Description | Updated description |
| Priority | Updated priority level |
Response
Upon successful update, the action returns the updated case details.
Add Case Comment
Adds a comment to an existing case in Workday.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Case ID | The unique identifier of the case |
| Comment | The text of the comment to add |
Response
Upon successful addition, the action returns confirmation of the comment being added.
Get Case Comments
Retrieves all comments associated with a specific case.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Case ID | The unique identifier of the case |
Optional
| Name | Description |
|---|---|
| Limit | Maximum number of results to return |
| Offset | Number of results to skip for pagination |
Response
The action returns a list of comments with author, timestamp, and comment text.
Get Case Types
Retrieves the available case types configured in Workday.
Input Parameters
No mandatory input parameters required.
Response
The action returns a list of case types with their IDs and names.
Get Case Statuses
Retrieves the available case statuses configured in Workday.
Input Parameters
No mandatory input parameters required.
Response
The action returns a list of case statuses with their IDs and names.
Run Custom Report (RaaS)
Executes a custom report in Workday using the Report-as-a-Service (RaaS) functionality. The Agent can leverage this action to run any custom report that has been published in Workday and retrieve its output data.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Report URL | The RaaS endpoint URL for the custom report |
Optional
| Name | Description |
|---|---|
| Parameters | Query parameters to pass to the report (e.g., filters) |
| Format | Output format for the report data |
Response
The action returns the report output data in the requested format.
Updated 7 days ago
