Self-Service Agent Tools
Each Self-Service Agent skill is made up of different actions a user can take, called tools. Tools are an abstraction layer (facade) over Workday APIs that the agent calls to perform tasks.
This topic contains Self-Service Agent tool names, descriptions, and limitations, grouped by the skill they're associated. You can also view this information - along with security requirements for each tool - directly in Workday by accessing the
View Security for Agent Skill
report. Skill and tool configuration changes can take up to 10 minutes to take effect for Self-Service agent due to caching.
ESS - Help - Advanced
Tool | Description | Limitations |
|---|---|---|
create_a_case | Enables users to initiate and submit formal support requests to ensure complex issues are documented and routed correctly for resolution. |
ESS - Human Capital Management - Advanced
Tool | Description | Limitations |
|---|---|---|
change_home_contact_info | Enables users to update their home address and personal phone number(s) in Workday.
Supports custom validations. | Doesn't support file uploads.
Managers can't update home contact info on behalf of direct reports. |
change_marital_status | Guides a user through updating their marital status in three sequential steps: initiation, draft creation, and submission.
Supports custom validations. | This tool is for status changes, not read-only profile questions.
Doesn't support removing or clearing a marital status. The change might enter an approval workflow and return a pending status until fully effective. |
change_name | Enables a user to update their legal name and/or preferred name in Workday only.
Supports custom validations. | Other name components, such as social name and former name, aren't supported.
Doesn't support file uploads such as legal name change certificates. Doesn't support the effective date of a legal name. |
request_reference_letter | Initiates a request for a standard employment verification or reference letter for the current user based on data on file in Workday. | Managers can't initiate reference letter requests for direct reports.
Doesn't support custom language, non-standard fields, client-specific formatting, or custom validations. |
ESS - Human Capital Management - Base
Tool | Description | Limitations |
|---|---|---|
view_bonus_history | Retrieves historical data for bonuses and one-time payments, such as spot bonuses and gift cards, for the user. Provides payment amounts, currency, effective or scheduled dates, plan names, bonus percentages, and the formal reason for the payment. Supports queries for the most recent payment, a specific calendar year’s history, or a summary of the three most recent events. Automatically retrieves all records if multiple payments occur on the same date. | Doesn’t display clawbacks, non-bonus plan types, or future/projected payments. |
view_coworker_info | Searches for a coworker by name and/or worker ID to retrieve professional information such as title, manager, location, and, where permitted by the user's security access, personal contact fields such as home email and home phone. Retrieves 1 profile for each call. | The fields that the agent returns depend on the session user's security access. For example, Home Email and Home Phone fields are returned only when the user has access to those fields.
Doesn't return sensitive personal fields, such as home addresses. Ambiguous names with multiple matches requires user clarification. Doesn't support bulk or list lookups. |
view_dependents | Retrieves a list of all active dependents for the user, including the dependent's name, relationship type, date of birth, age, gender, and tobacco status. | |
view_healthcare_elections | Displays active healthcare enrollment offerings and elections information for the user and their dependents, such as plan name, provider, coverage target, costs per frequency, available level options, and external provider URLs. | Only retrieves Healthcare and Retirement Benefits, not additional benefits such as insurance benefits. |
view_my_team | Retrieves the list of users on the current session user's my-team list, including display names and headcount. This tool retrieves peers under the same manager, not the user's direct reports. | Detailed profile information such as title or contact details is not included; use view_coworker_info for individual details.
Displays an empty team list when the manager has no other direct reports |
view_org_info | Retrieves organization records for organizations the user belongs to or from a specific name search. Results include organization identifiers, status, and location fields. | Retrieves org-level metadata rather than a member roster; use view_my_team or view_direct_reports for people-level queries.
Location and address fields are retrieved as stored in Workday with no locale transformation applied. |
view_personal_info | Retrieves personal information details from the session user's personal and employment profile. Not all profile fields are supported even if they exist. This tool retrieves data for the authenticated session user only; use view_coworker_info for other workers. It uses a read-only GraphQL API with no write capabilities. | Doesn't retrieve fields such as emergency contacts or custom profile.
Date formats and field labels are retrieved as stored in Workday with no locale-based transformation applied. |
view_retirement_savings | Retrieves the user's active retirement savings plan details, including plan name, coverage type, and frequency. Retrieves contribution rates for both employees and employers, including minimums and maximums, as well as beneficiary allocations such as names and percentages. | |
view_total_compensation | Retrieves the user's total base pay, total compensation, pay frequency, and compensation grade, pay range details, and a summary of all stock grants grouped by type and the associated vesting schedule. | Doesn't predict future stock vesting dates or format step progression details beyond the provided string. |
ESS - Payroll - Base
Tool | Description | Limitations |
|---|---|---|
model_my_pay | Enables hourly workers to model and plan for possible pay change scenarios. Example prompts:
Retrieves hourly payroll result lines if the pay component includes rate and hour pay component related calculations. | You must configure pay modeling in your tenant. See Set Up Pay Modeling. Workers must have at least 1 completed pay period with hourly pay to prompt the agent successfully. |
view_direct_deposit | Retrieves user's bank accounts and direct deposit information used in payment elections, including the default country and currency. | Doesn't provide information about payment elections that aren't associated with a bank account. |
view_next_paydate | Retrieves the next payroll payment date for on-cycle payments for a user’s primary pay group. | Available only for Australia, Canada, France, Ireland, UK, and USA.
Additional configuration is required for workers assigned to a Payroll Interface pay group. |
view_payslips | Retrieves either the user's latest payslip or payslips filtered by dates. Includes information such as payment date, period dates, gross, net, and YTD aggregated values. Available for Australia, Canada, France, Ireland, UK, and USA, as well as external payslips. | Doesn't support custom labels, line-item details, such as 401K, or net-zero payslips. Doesn't acknowledge the Disable Payslip Viewing (Online Version) check box election on the Edit Tenant Setup – Payroll task.External payslips only provides gross and net data. |
view_w2 | Enables a user to view information about their most recent US Wage and Tax Statement (Form W-2). Information is limited to the most recent year and the most recently generated company W-2. | Doesn't retrieve individual W-2 box information. |
view_w4 | Enables a user to view the details of their US federal tax withholding election (Form W-4) for a specified date. When no date is specified, the tool returns details about the most recent election that has an associated Effective Date. |
ESS - Talent Management - Advanced
Tool | Description | Limitations |
|---|---|---|
create_referral | Enables users to submit a referral for an external candidate to 1 or more job requisitions using job requisition IDs such as candidate's name, country, contact details, optional address, and notes. The specified job requisition ID must be for an active, non-confidential job requisition posted externally. | Doesn't support resume or file uploads.
Doesn't display referral status after submission. Doesn't support custom validations. Submission might fail when referral consent for certain candidate countries is missing. |
distribute_journey | Enables employees to distribute journeys themselves. | |
start_performance_review_self | Initiates a self-performance review by resolving the appropriate category and template and prompting the user for a choice when necessary.
Supports custom validations. | Once the review is initiated and inputs are validated, any further interactions must be completed through the Workday UI. |
request_feedback_self | Enables users to request feedback from other users by selecting specific feedback templates and determine whether the responses should be private to them or visible to others. |
ESS - Talent Management - Base
Tool | Description | Limitations |
|---|---|---|
find_jobs | Enables users to search approved internal job postings using structured filters such as location, skills, manager, or job requisition ID. | Does not support free-form keyword search or infer a coworker’s role to find similar jobs.
Results are retrieved in pages with a limited count per response. |
find_journeys | Enables users to search, filter, and retrieve available journeys. This tool displays details for self-service and distributed journeys, and provides specific journeys details when prompted. | |
view_feedback | Displays feedback the user has received (both unsolicited anytime and requested) along with the status of pending requests. Includes the date, the provider, and the feedback content with options to filter by date or person. Managers can also view a summary count of feedback requests for their direct reports. | |
view_my_goals | Retrieves personal goals including status, due date, and organization alignment. | Doesn't support date range filtering or fields such as Target Amount, Milestones, and Cascaded Goals. |
view_org_goals | Retrieves an organization's goals for a specified date range, defaulting to the current user's primary-job supervisory organization.
Provides goal names, descriptions, completion percentages (0–100), and parent goal references. | Limited to active supervisory organizations.
Doesn't support searching by name or description. |
view_performance_review | Retrieves the user's completed or in-progress performance reviews. Only retrieves overall ratings for managers and employees for each section. Users can filter the list by status. | Doesn't display the manager or employee's overall comments. Only retrieves overall ratings for managers and employees for each section. |
view_talent_profile_details | Retrieves specific talent profile sections, such as job history, skills, and education for the current user or another worker by their name or ID. |
ESS - Workforce & Frontline Management - Advanced
Tool | Description | Limitations |
|---|---|---|
cancel_time_off | Initiates the Correct Time Off business process to cancel or delete an approved time off entry. Also supports the cancelation of in-progress time off request and correction events. | |
edit_time_off | Initiates the Correct Time Off business process to edit an approved time off entry. Supports modifications to quantity, start and end times, and reasons for both standard time off and absence tables.
Supports custom validations. | Doesn't support corrections to the time off type, position, or worktags, and it doesn't display system warnings. |
enter_time_block | Enables a user to create time entries for 1 or more days using quantity-based entries (# of hours) or in/out time-based entries (specific times of day). | Doesn't support worktag entry or project-based time entry codes.
Doesn't support time blocks requiring worktag selection, such as cost center, location, or division. |
request_time_off | Initiates a time off request, such as vacation and sick leave, using the Request Time Off business process.
Supports custom validations. | Doesn't support requests with worktags configured, system warnings or start/end times. |
shift_check_in | Enables a user to clock in at the beginning of their shift to start recording worked time. The tool automaticallt resolves available time entry codes and positions. | Doesn't support worktag entry or project-based time entry codes; users requiring worktags can't complete check-in through this tool. |
shift_check_out | Enables a user to clock out of their shift, either for a break or for the end of their shift, to stop recording their worked time. | |
submit_time | Submits a user's timesheet for review and approval for a single date. Includes all time entries for the full time period the date falls within. For example, any date within a weekly pay period will submit the entire week. | Doesn't support custom validations. |
update_time_block_comment | Adds or updates a comment associated with a specific time block. | Doesn't support editing any other fields on the time block, such as time type or quantity. |
ESS - Workforce & Frontline Management - Base
Tool | Description | Limitations |
|---|---|---|
my_time_off_events | Retrieves the user's time off events with a status of Approved, Submitted, Not Submitted, or Sent Back for a specified date range.
When an approved entry has been corrected, the tool retrieves the latest corrected entry only. | Doesn't retrieve Cancelled or Denied time off entries. |
time_off_balance | Retrieves and displays the user's time off balances as of an effective date. | Doesn't return time off carryover, expiring accrual balances, or expiration details. |
time_off_types | Displays all the types of time off the user is eligible for.
Supports custom validations. | Excludes time off types that can't be entered through the standard process, such as those enabled only for time tracking, forfeiture adjustments, or selling. |
view_holiday_calendar | Retrieves the user’s company holiday calendar events for a specified date range. | While the tool identifies the holidays, it doesn't return the specific duration of the holiday calendar event. |
view_time_blocks | Displays all recorded time blocks for a specified date range for the user. | Results are limited to the first 20 time blocks per request. |
Guide
Tool | Description | Limitations |
|---|---|---|
navigation_deeplink | Provides a direct navigational link to the correct task or report within the Workday system when the agent can't answer a question directly. |
MSS - Human Capital Management - Base
Tool | Description | Limitations |
|---|---|---|
recommend_change_job_template | Recommends a predefined template for a Change Job request based on the user's context.
Template recommendations are driven by the user's current job profile, location and organization. | Only surfaces the recommendation; doesn't initiate or submit the actual job change workflow. |
view_direct_reports_info | Retrieves professional profile information, such as anniversary dates, birthdays, promotion history, and tenure, for a manager's direct reports or a specific worker | Provides data for direct reports only, not skip-level reports.
Managers with large teams might experience higher response volume. Depending on an individual's employment record, some fields might not populate. |
view_direct_reports | Retrieves the names and IDs of the workers who report directly to the manager user. | Only provides data for direct reports, not skip-level reports.
For broader organization hierarchy context, use view_org_info instead or consider asking your question in another way. For richer profile data on direct reports, use view_direct_reports_info or view_coworker_info instead. |
view_worker_history | Retrieves employment-related details for events such as hire, job change, and compensation for the user or a named worker within a specified date range. Each invocation retrieves a single event category. | When a name is provided, the worker must be part of the manager's reporting structure.
When multiple or zero matches are found for a name, the tool returns an error rather than a list. |
MSS - Payroll - Advanced
Tool | Description | Limitations |
|---|---|---|
request_payroll_input | Guides authorized users in creating payroll input requests for earnings or deductions by identifying eligible pay components and retrieving the next available payroll start date for accurate scheduling. | Doesn't support custom validations. |
MSS - Talent Management - Advanced
Tool | Description | Limitations |
|---|---|---|
start_performance_review_worker | Starts a new Employee Review business process for a manager's single direct report or for their entire team. | While you must select a template and period dates, you can only use 1 template when starting reviews for all direct reports simultaneously.
Doesn't support custom validations. |
request_feedback_worker | Enables a manager to request feedback about a worker from other users. Users can select specific feedback templates and determine if the responses should be confidential or visible to others. |
MSS - Talent Management - Base
Tool | Description | Limitations |
|---|---|---|
find_job_requisition | Displays up to 10 open or in-progress job requisitions for supervisory organizations where the manager holds a leadership role. | Excludes evergreen requisitions and internal apply postings. |
view_candidate_status | Retrieves application information, such as skills, experience, and links for managers, recruiters, and candidates that have My Candidates access. | Doesn't retrieve information for candidates without My Candidates.
Links and formatting in chat might be inconsistent, such as the inability to click links in some scenarios. |
view_team_goals | Aggregates and retrieves up to 100 goals for a manager's direct reports, grouped by worker and completion status. Supports filters for status, keywords, and due dates. | Doesn't support filters for milestones, categories, or specific target and actual currency fields. |
view_team_learning_status | Retrieves learning records such as completion, grade, and expiration for a manager's direct team. | Only provides data on learning activities in which the team has already formally enrolled; assigned but not-yet-enrolled training is excluded.
Doesn't support filtering by due dates or individual learners. |
view_team_performance_review | Retrieves high-level review metadata and overall ratings for the supervisory organization the manager leads. | When a manager leads multiple organizations, only the first supervisory organization is retrieved.
Doesn't support non-overall section ratings or comments. |
MSS - Workforce & Frontline Management - Advanced
Tool | Description | Limitations |
|---|---|---|
approve_time_entries | Enables a user to approve time entries for multiple workers. | Displays a maximum of 60 records, with 20 records per page. |
create_time_blocks_workers | Enables a user to create time blocks for multiple workers. | For a maximum of:
Doesn't support projects or worktags. |
deny_time_entries | Enables a user to deny time entries for multiple workers. | Displays a maximum of 60 records, with 20 records per page. |
send_back_time_entries | Enables a user to send back time entries for multiple workers. | Displays a maximum of 60 records, with 20 records per page. |
MSS - Workforce & Frontline Management - Base
Tool | Description | Limitations |
|---|---|---|
view_direct_reports_time_off | Retrieves time off events (Approved, Submitted, Not Submitted, or Sent Back) for a manager's direct reports within a specified date range.
When an approved time off entry is corrected, the tool retrieves only the latest version. | Doesn't reference your specific team absence configuration or retrieve cancelled and denied entries. |
view_time_blocks_workers | Retrieves time blocks for multiple workers. | Displays up to 100 time blocks for a maximum of 20 workers for a maximum date range of 1 month.
Doesn't display project time entry details. |
view_submitted_time_entries_workers | Retrieves submitted time entries for multiple workers. | Displays a maximum of 60 records, with 20 records per page. |
Policy Intelligence
Tool | Description | Limitations |
|---|---|---|
search_policy_documents | Retrieves company policy and procedural information from Help Knowledge Base articles to ensure responses are accurate and based on official documentation. |
|