Hr & Payroll

Workday

Learn how to use Workday with Composio

Overview

SLUG: WORKDAY

Description

Workday is a cloud-based enterprise resource planning (ERP) software that provides comprehensive solutions for human capital management, financial management, and analytics

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to System
bearer_token
string
full
stringRequired
authorizationUrl
stringRequired
tokenUrl
stringRequired

Connecting to Workday

Create an auth config

Use the dashboard to create an auth config for the Workday toolkit. This allows you to connect multiple Workday accounts to Composio for agents to use.

1

Select App

Navigate to Workday.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Workday Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4workday_auth_config_id = "ac_YOUR_WORKDAY_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11    connection_request = composio.connected_accounts.initiate(
12        user_id=user_id,
13        auth_config_id=auth_config_id,
14    )
15
16    print(
17        f"Visit this URL to authenticate Workday: {connection_request.redirect_url}"
18    )
19
20    # This will wait for the auth flow to be completed
21    connection_request.wait_for_connection(timeout=15)
22    return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, workday_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Workday toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["WORKDAY"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Time Off Request

Description

Creates a time off request for the specified worker id and initiates the business process.

Action Parameters

ID
stringRequired
businessProcessParameters
objectRequired
days
arrayRequired
timeOffRequestEventView
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Absence Balance

Description

Retrieves the specified balance of all absence plan and leave of absence types.

Action Parameters

ID
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Balance Details

Description

Retrieves the specified balance of all absence plan and leave of absence types.

Action Parameters

ID
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Current User

Description

Retrieves the current authenticated worker's profile information from workday.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Holiday Events

Description

Returns the holiday events for the specified workers and time period.

Action Parameters

fromDate
string
limit
integer
offset
integer
toDate
string
worker
array

Action Response

data
arrayRequired
error
string
successful
booleanRequired
total
integer

Tool Name: Get Interview Feedback

Description

Retrieves feedback entries for a specific interview to prepare debrief notes with highlights and lowlights.

Action Parameters

ID
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Job Posting

Description

Retrieves detailed information about a specific job posting including job description.

Action Parameters

ID
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Job Posting Questionnaire

Description

Retrieves screening questions and questionnaires associated with a specific job posting.

Action Parameters

ID
stringRequired
limit
integer
offset
integer
questionnaireType
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Leave Status Values

Description

Retrieves instances that can be used as values for other endpoint parameters in this service.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get My Job Postings

Description

Finds all job postings assigned to a specific recruiter by analyzing interviews and job requisitions.

Action Parameters

include_closed
boolean
limit
integerDefaults to 100

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prospect

Description

Retrieves a single prospect instance for talent matching and best-fit analysis.

Action Parameters

ID
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prospect Educations

Description

Retrieves the education of a prospect for talent matching and best-fit analysis.

Action Parameters

ID
stringRequired
limit
integer
offset
integer

Action Response

data
arrayRequired
error
string
prospect_id
stringRequired
successful
booleanRequired
total
integer

Tool Name: Get Prospect Experiences

Description

Retrieves the work experience of a prospect for talent matching and best-fit analysis.

Action Parameters

ID
stringRequired
limit
integer
offset
integer

Action Response

data
arrayRequired
error
string
prospect_id
stringRequired
successful
booleanRequired
total
integer

Tool Name: Get Prospect Resume Attachments

Description

Retrieves resume attachments for a specific prospect to help prepare for upcoming interviews.

Action Parameters

ID
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prospect Skills

Description

Retrieves the skills of a prospect for talent matching and best-fit analysis.

Action Parameters

ID
stringRequired
limit
integer
offset
integer

Action Response

data
arrayRequired
error
string
prospect_id
stringRequired
successful
booleanRequired
total
integer

Tool Name: Get Time Off Status Values

Description

Retrieves instances that can be used as values for other endpoint parameters in this service.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Worker Eligible Absence Types

Description

Retrieves a collection of eligible absence types for the specified worker.

Action Parameters

ID
stringRequired
category
string
effective
string
limit
integer
offset
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired
total
integer

Tool Name: Get Worker Leaves of Absence

Description

Retrieves the leaves of absence for the specified worker using the working absencemanagement v1 api.

Action Parameters

ID
stringRequired
fromDate
string
leaveType
array
limit
integer
offset
integer
status
array
toDate
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired
total
integer

Tool Name: Get Worker Time Off Details

Description

Retrieves a collection of time off details for the specified worker.

Action Parameters

ID
stringRequired
fromDate
string
limit
integer
offset
integer
status
array
timeOffType
array
toDate
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired
total
integer

Tool Name: Get Worker Valid Time Off Dates

Description

Retrieves the valid time off dates for the specified worker id for the given dates.

Action Parameters

ID
stringRequired
date
string
limit
integer
offset
integer
position
string
timeOff
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired
total
integer

Tool Name: List Absence Balances

Description

Retrieves the balance of all absence plan and leave of absence type for the specified worker id.

Action Parameters

category
string
effective
string
limit
integer
offset
integer
worker
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired
total
integer

Tool Name: List Balances

Description

Retrieves the balance of all absence plan and leave of absence type for the specified worker id.

Action Parameters

category
string
effective
string
limit
integer
offset
integer
worker
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired
total
integer

Tool Name: List Interviews

Description

Retrieves a list of interviews with job requisition and recruiter assignment details. supports filtering by status for pipeline review and scheduled interviews.

Action Parameters

interviewStatus
array
limit
integer
offset
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired
total
integer

Tool Name: List Job Postings

Description

Retrieves a list of job postings from workday recruiting system with filtering options.

Action Parameters

category
array
jobPosting
array
jobRequisition
array
jobSite
array
limit
integer
offset
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired
total
integer

Tool Name: List Workers

Description

Retrieves a collection of workers and current staffing information.

Action Parameters

includeTerminatedWorkers
boolean
limit
integer
offset
integer
search
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired
total
integerRequired