Workday (Beta) Connector

This component is currently in BETA.

BETA component connections and actions may not always work as expected. Please report any feedback through the support channel.

Workday HCM is a single, cloud-based solution for workforce planning, talent management, and payroll processes.

The Workday component allows managing Organizations, People, Workers, and more.

API Documentation

This component was built using the Workday REST Services API reference.

Connections

OAuth 2.0

Authenticate using OAuth 2.0.

Prerequisites

Before configuring the connection, the following are required:

A Workday tenant ID.
Administrator access to the Workday tenant to register an API client.
The Workday domain used by the tenant (for building the API base URL).

Setup Steps

The API client is registered in the Workday portal based on the category. This process also surfaces the information required to set up the Workday REST Access Token account.

Log into the Workday Portal
- Use valid Workday Org admin credentials.
- Format: https://impl.workday.com/wday/authgwy/<tenant_name>/login.htmld
Search and Register
- From the Search menu for the Workday categories, select Register API Client and click Register.
Provide Mandatory Details
- Client Name: Specify a name for the API Client.
- Client Grant Type: Select Authorization Code Grant.
- Enforce 60 Minutes Access Token Expiry: Ensure this is selected so the auto-refresh token works correctly in the Workday REST OAuth2 Account.
- Access Token Type: Select Bearer.
- Redirect URL: Enter the redirect URL: https://oauth2.integrations.acme.com/callback
- Scope: Select the required services from the dropdown list.
Complete Registration
- Click Done.

After the API client is registered in the Workday portal, note the Client ID, Client Secret, and Endpoints to be used in the integration workflow.

Configure the Connection

Create a connection of type OAuth 2.0 and provide the following inputs:

Authorize URL (required): The OAuth 2.0 Authorization URL for Workday. Replace <tenant_id> with the Workday tenant ID.
Token URL (required): The OAuth 2.0 Token URL for Workday. Replace <tenant_id> with the Workday tenant ID.
Scopes (optional): Space-separated list of OAuth 2.0 scopes, if any are required.
Client ID (required): The OAuth 2.0 client ID issued by Workday for the registered API client.
Client Secret (required): The OAuth 2.0 client secret paired with the Workday client ID.
API URL (required): The base URL for the Workday API. Replace <domain> with the Workday domain.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
Authorize URL	The OAuth 2.0 Authorization URL for Workday. Replace <tenant_id> with the tenant ID.	https://impl.workday.com/<tenant_id>/authorize
Token URL	The OAuth 2.0 Token URL for Workday. Replace <tenant_id> with the tenant ID.	https://wd2-impl-services1.workday.com/ccx/oauth2/<tenant_id>/token
Scopes	Space-separated list of OAuth 2.0 scopes, if any are required.
Client ID	The OAuth 2.0 client ID issued by Workday for the registered API client.
Client Secret	The OAuth 2.0 client secret paired with the Workday client ID.
API URL	The base URL for the Workday API. Replace with the Workday domain.	https:///ccx

Actions

Create File Container

Creates a new file container.

Input	Comments	Default
Connection	The Workday connection to use.
Tenant	The Workday tenant name used in API paths.

Create Job Change

Creates a job change instance with the specified data.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Supervisory Organization ID	Supervisory organization assigned to the worker as of the effective date.
Job Change Reason ID	Identifies the reason used in a Change Job business process.
Move Managers Team	When true, also moves subordinate teams to the new manager.	false
Effective Date	The date this business process takes effect.
Proposed Organizations	Organizations with staffing behavior assigned to the position as a result of this event.
Instance ID	Identifies the Workday instance being referenced.
Instance Href	Direct API link pointing to the referenced instance.
Instance Descriptor	Human-readable preview label for the referenced instance.

Create Message Template

Creates a new message template.

Input	Comments	Default
Connection	The Workday connection to use.
Message Template Name	Display name given to the message template.
Created By ID	Identifies the user who created the record.
Email Detail	Details for the email.
Push Detail	Details for the push notification.
Reference ID	Reference ID used for lookups within Workday Web Services.
Template Inactive	When true, marks the template as inactive.	true
Template Descriptor	Human-readable descriptor for the template.
Template ID	Identifies the message template record.
Additional Fields	Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information.

Create Payment

Creates a single customer invoice payment header instance with the specified data.

Input	Comments	Default
Connection	The Workday connection to use.
Remit From Customer ID	Identifies the customer remitting the payment.
Amount	Monetary amount for the payment.
Type ID	Identifies the payment type.
Payment Date	Date the payment was made.
Company ID	Identifies the Workday company.
Payment ID	Optional identifier to assign to the payment on creation.
Additional Fields	Additional optional fields: includes Ready to Auto Apply, Reference, Transaction Number, Memo, and Payment Descriptor.
Ready to Auto Apply	When true, flags the payment as ready for automatic application.	true
Reference	External reference string associated with the payment.
Transaction Number	Bank transaction number associated with the payment.
Memo	Free-text memo attached to the transaction.
Payment Descriptor	Human-readable descriptor for the payment.

Create Supplier Invoice Request

Creates a supplier invoice request with the specified data.

Input	Comments	Default
Connection	The Workday connection to use.
Currency ID	Identifies the currency used for the invoice.
Company ID	Identifies the Workday company.
Tax Amount	Total tax amount applied to the invoice.
Requester ID	Identifies the worker who requested the invoice.
Control Total Amount	Expected total amount used to validate invoice line totals.
Payment Terms ID	Identifies the payment terms that apply to the invoice.
Reference Type ID	Identifies the reference type for the invoice.
Memo	Free-text memo attached to the transaction.
Supplier Invoice ID	Identifies the supplier invoice.
Supplier Invoice Descriptor	Human-readable descriptor for the supplier invoice.
Additional Fields	Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information.

Create Supplier Invoice Request Attachment

Creates attachments for the specified supplier invoice.

Input	Comments	Default
Connection	The Workday connection to use.
Supplier Invoice Request ID	Identifies the supplier invoice request.
Attachment Details	File length, file name, and descriptor for the attachment.
File Length	Size of the attached file in bytes.
File Name	Display name of the attached file.
Supplier Invoice Request Attachment Descriptor	Human-readable descriptor for the attachment.
Content Type ID	Identifies the MIME content type of the attachment.
Supplier Invoice Request Attachment ID	Identifies the attachment on the supplier invoice request.

Create Table

Creates a new table with the specified name.

Input	Comments	Default
Connection	The Workday connection to use.
Tenant	The Workday tenant name used in API paths.
Display Name	User-facing display name shown in Prism Analytics.
Name	Internal name used to reference the table via API.
Fields	The fields of the table. An array of objects. See Workday API documentation for more information.
Additional Fields	Additional optional fields: includes Description, Documentation, Enable For Analysis, and Tags.
Description	Short description shown alongside the table.
Documentation	Long-form documentation describing how the table is used.
Enable For Analysis	When true, enables the table for Prism Analytics.	false
Tags	The tags of the table. An array of objects with id and name.

Create Time Off Request

Creates a time off request for the specified worker ID and initiates the Request Time Off business process.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Days	The days for which the time off request is being made. An array of objects. See Workday API documentation for more information.
Action ID	Identifies the action to take on the business process.
Overall Business Process ID	Identifies the parent business process instance.
Time Off Comment	Free-text comment attached to the time-off entry.
Transaction Status ID	Identifies the current status of the transaction.
Time Off Attachments	The attachments for the time off request.
Time Off For ID	Target instance the time-off entry applies to; may be another business process ID when used as a sub-process.

Create Worker Business Title Change

Creates a new business title change for the specified worker.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Proposed Business Title	New business title for the worker as of the effective date. If there is no business title override, this field defaults to the job title or job profile name.
Instance ID	Identifies the Workday instance being referenced.
Instance Href	Direct API link pointing to the referenced instance.
Instance Descriptor	Human-readable preview label for the referenced instance.

Create Worker Time Block

Creates a worker time block for the specified worker.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Do Not Bill	When true, marks the time block as non-billable.	false
Comment	Free-text comment attached to the reported time block.
Instance ID	Identifies the Workday instance being referenced.
Instance Descriptor	Human-readable preview label for the referenced instance.
Additional Fields	Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information.

Delete Time Clock Event by ID

Deletes a time clock event with the specified ID.

Input	Comments	Default
Connection	The Workday connection to use.
Time Clock Event ID	Identifies the time clock event record.

Delete Worker Time Block

Deletes a worker time block with the specified ID for the specified worker.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Worker Time Block ID	Identifies the worker's reported time block.

Get Customer by ID

Retrieves a customer by ID.

Input	Comments	Default
Connection	The Workday connection to use.
Customer ID	Identifies the customer account.

Get Data Change by ID

Retrieves the data change with the specified ID. A data change is a Prism artifact used to load data into a Prism table for analysis in downstream applications such as Discovery Board, Reports, Accounting Center, and People Analytics.

Input	Comments	Default
Connection	The Workday connection to use.
Tenant	The Workday tenant name used in API paths.
Data Change ID	Identifies the Prism Analytics data change transaction.

Get Event Attachments

Retrieves attachments on the specified business process event that the processing user has permission to view.

Input	Comments	Default
Connection	The Workday connection to use.
Event ID	Identifies the business process event.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Get Event by ID

Retrieves the business process event with the specified ID.

Input	Comments	Default
Connection	The Workday connection to use.
Event ID	Identifies the business process event.

Get Files by Container ID

Retrieves all files for a file container. Returns file metadata such as file name, size, checksum, and state (Timed Out, Uploading, Failed, Success). Only files with state 'Success' are ready for upload.

Input	Comments	Default
Connection	The Workday connection to use.
Tenant	The Workday tenant name used in API paths.
File Container ID	Identifies the file container whose files will be retrieved.

Get Invoice by ID

Retrieves a customer invoice or adjustment with the specified ID.

Input	Comments	Default
Connection	The Workday connection to use.
Invoice ID	Identifies the customer invoice to retrieve.

Get Invoice PDF

Retrieves printed customer invoice PDF documents.

Input	Comments	Default
Connection	The Workday connection to use.
Invoice PDF ID	Identifies the invoice PDF resource to retrieve.

Get Message Template by ID

Retrieves a message template by ID.

Input	Comments	Default
Connection	The Workday connection to use.
Message Template ID	Identifies the Connect message template.

Get Organization by ID

Retrieves an organization by ID.

Input	Comments	Default
Connection	The Workday connection to use.
Organization ID	Identifies the Workday organization.

Get Payment by ID

Retrieves a customer invoice payment with the specified ID.

Input	Comments	Default
Connection	The Workday connection to use.
Payment ID	Identifies the customer payment record.

Get Person by ID

Retrieves a person with the specified ID. IDs returned from 'List People' or 'List Workers' can be used to retrieve further information about a specific person.

Input	Comments	Default
Connection	The Workday connection to use.
Person ID	Unique identifier for a person in the Workday tenant.

Get Staffing Worker by ID

Retrieves a worker with the specified ID and current staffing information from the Staffing service.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.

Get Staffing Workers

Retrieves a collection of workers and current staffing information from the Staffing service.

Input	Comments	Default
Connection	The Workday connection to use.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

Get Supplier Invoice Request Attachments

Retrieves all attachments associated with supplier invoices.

Input	Comments	Default
Connection	The Workday connection to use.
Supplier Invoice Request ID	Identifies the supplier invoice request.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Get Supplier Invoice Request by ID

Retrieves the supplier invoice with the specified ID.

Input	Comments	Default
Connection	The Workday connection to use.
Supplier Invoice Request ID	Identifies the supplier invoice request.

Get Table by ID

Retrieves the description of a table or dataset the current user has permission to access.

Input	Comments	Default
Connection	The Workday connection to use.
Tenant	The Workday tenant name used in API paths.
Table ID	Identifies the Prism Analytics table.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

Get Time Clock Event by ID

Retrieves a time clock event with the specified ID.

Input	Comments	Default
Connection	The Workday connection to use.
Time Clock Event ID	Identifies the time clock event record.

Get Time Clock Events

Retrieves a collection of time clock events. Supports filtering by worker and date range.

Input	Comments	Default
Connection	The Workday connection to use.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123

Get Time Off Balance by ID

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

Input	Comments	Default
Connection	The Workday connection to use.
Balance ID	Identifies the time-off balance to retrieve.

Get Time Off Details

Retrieves Time Off Entries for the specified worker ID. Supports filtering by date range, status, and type; returns all entries when no query parameters are specified.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

Get Worker Business Title Changes

Retrieves a collection of business title changes for the specified worker.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Get Worker by ID

Retrieves a worker and current staffing information by ID.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.

Get Worker Explicit Skills

Retrieves explicit skills for the specified worker ID. Supports optional filtering by skill name or skill source.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

Get Worker Service Dates

Retrieves a collection of service dates (hire date, continuous service date, etc.) for the specified worker ID.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Initiate Job Change

Initiates a job change request for the specified worker. Returns a new job change ID that can be submitted with POST /jobChanges/{ID}/submit.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Effective Date	The effective date of the job change.
Change Job Worker ID	Workday ID of the worker whose job is being changed. Retrieve using GET /values/jobChangesGroup/workers.
Job ID	Workday ID of the target job or position. Retrieve using GET /values/jobChangesGroup/jobs with the worker query parameter.
Reason ID	Workday ID of the change job reason. Retrieve using GET /values/jobChangesGroup/reason.
Additional Fields	Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information.

Initiate Organization Assignment Change

Initiates an organization assignment change for the specified worker. Returns a new change ID that can be submitted with POST /organizationAssignmentChanges/{ID}/submit.

Input	Comments	Default
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Effective Date	The effective date of the organization assignment change.
Change Org Worker ID	Workday ID of the worker whose organization assignment is being changed. Retrieve using GET /values/organizationAssignmentChangesGroup/workers.
Job ID	Workday ID of the worker's current position. Retrieve using GET /values/organizationAssignmentChangesGroup/jobs with the worker query parameter.
Additional Fields	Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information.

List Data Changes

Returns the collection of data changes accessible to the authenticated user. Supports offset and limit query parameters. Response type is determined by the 'type' query parameter. The default response includes id, name, and displayName.

Input	Comments	Default
Connection	The Workday connection to use.
Tenant	The Workday tenant name used in API paths.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

List Events

Retrieves a collection of business process events based on the specified parameters. Exactly one worker parameter must be specified; otherwise, a blank response is returned.

Input	Comments	Default
Connection	The Workday connection to use.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

List Invoices

Retrieves all customer invoices and adjustments.

Input	Comments	Default
Connection	The Workday connection to use.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123

List Message Templates

Retrieves message templates.

Input	Comments	Default
Connection	The Workday connection to use.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123

List Organizations

Retrieves a list of organizations.

Input	Comments	Default
Connection	The Workday connection to use.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123

List People

Retrieves all people in the Workday tenant.

Input	Comments	Default
Connection	The Workday connection to use.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

List Supplier Invoice Requests

Retrieves all supplier invoices.

Input	Comments	Default
Connection	The Workday connection to use.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

List Tables

Retrieves a collection of tables created by the Workday REST API. Only tables or datasets permitted by the current user's security profile are returned.

Input	Comments	Default
Connection	The Workday connection to use.
Tenant	The Workday tenant name used in API paths.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

List Workers

Retrieves a collection of workers and current staffing information.

Input	Comments	Default
Connection	The Workday connection to use.
Fetch All	When enabled, automatically fetches all pages of results using limit/offset pagination. Limit and Offset inputs are ignored when this is enabled.	false
Pagination	Page-size and starting-position controls for the result collection.
Limit	The maximum number of objects in a single response. The default is 20. The maximum is 100.
Offset	The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input to control paging of a response collection. Example: If Limit is 5 and Offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Query Params	Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

Raw Request

Sends a raw HTTP request to Workday.

Input	Comments	Default
Connection	The Workday connection to use.
URL	Input the path only (/accountsPayable/v1/supplierInvoiceRequests), The base URL is already included (https:///ccx). For example, to connect to https:///ccx/accountsPayable/v1/supplierInvoiceRequests, only /accountsPayable/v1/supplierInvoiceRequests is entered in this field.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Send Message

Sends a message.

Input	Comments	Default
Connection	The Workday connection to use.
Sender Override ID	Overrides the icon displayed for the sender.
Communication ID	Identifier of the Workday communication group.
Message Details	Email, push notification, and recipient details for the message.
Email Detail	Details for the email.
Push Detail	Details for the push notification.
Contacts	Contacts to send the message to. This should be an array of contacts.
Message Template ID	Identifies the Connect message template.
Notification Type ID	Identifies the notification type used for delivery.

Submit Supplier Invoice Request

Submits a supplier invoice instance with the specified ID for approval.

Input	Comments	Default
Connection	The Workday connection to use.
Supplier Invoice Request ID	Identifies the supplier invoice request.
Supplier Invoice Instance ID	Identifies the supplier invoice instance to submit for approval.
Supplier Invoice Instance Descriptor	Human-readable descriptor for the supplier invoice instance being submitted.

Update Message Template by ID

Updates a message template by ID.

Input	Comments	Default
Message Template ID	Identifies the Connect message template.
Connection	The Workday connection to use.
Message Template Name	Display name given to the message template.
Created By ID	Identifies the user who created the record.
Email Detail	Details for the email.
Push Detail	Details for the push notification.
Reference ID	Reference ID used for lookups within Workday Web Services.
Template Inactive	When true, marks the template as inactive.
Template Descriptor	Human-readable descriptor for the template.
Template ID	Identifies the message template record.
Additional Fields	Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information.

Update Table by ID

Updates an existing table with the specified name.

Input	Comments	Default
Connection	The Workday connection to use.
Tenant	The Workday tenant name used in API paths.
Table ID	Identifies the Prism Analytics table.
Display Name	User-facing display name shown in Prism Analytics.
Name	Internal name used to reference the table via API.
Fields	The fields of the table. An array of objects. See Workday API documentation for more information.
Additional Fields	Additional optional fields: includes Description, Documentation, Enable For Analysis, and Tags.
Description	Short description shown alongside the table.
Documentation	Long-form documentation describing how the table is used.
Enable For Analysis	When true, enables the table for Prism Analytics.
Tags	The tags of the table. An array of objects with id and name.

Update Time Clock Event by ID

Updates the time clock event for the specified ID, replacing the existing time clock event with the specified data.

Input	Comments	Default
Connection	The Workday connection to use.
Time Clock Event ID	Identifies the time clock event record.
Instance Descriptor	Human-readable preview label for the referenced instance.
Instance Href	Direct API link pointing to the referenced instance.
Instance ID	Identifies the Workday instance being referenced.
Clock Event Date Time	Timestamp when the time clock event occurred.
Clock Event Time Zone ID	Identifies the time zone applied to the clock event.
Clock Event Override Rate	Optional rate that overrides the default pay rate for this event.
Reference ID	Reference ID used for lookups within Workday Web Services.
Clock Event Time Entry Code ID	Identifies the time entry code applied to the clock event.
Clock Event Project Plan Task ID	Identifies the project plan task associated with the clock event.
Clock Event Project ID	Identifies the project associated with the clock event.
Clock Event Comment	Free-text comment attached to the time clock event.
Additional Fields	Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information.

Update Worker Time Block

Updates the worker time block for the specified worker with the specified data in the request body.

Input	Comments	Default
Worker Time Block ID	Identifies the worker's reported time block.
Connection	The Workday connection to use.
Worker ID	Unique identifier for the Workday worker record.
Do Not Bill	When true, marks the time block as non-billable.
Comment	Free-text comment attached to the reported time block.
Instance ID	Identifies the Workday instance being referenced.
Instance Descriptor	Human-readable preview label for the referenced instance.
Additional Fields	Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information. See Workday API documentation for more information.

Upload Files by Container ID

Loads a file into the specified file container. Creates a temporary location to store the file and saves file metadata such as size and checksum.

Input	Comments	Default
Connection	The Workday connection to use.
Tenant	The Workday tenant name used in API paths.
File Container ID	Identifies the file container whose files will be retrieved.
File	The contents to write to a file. Binary data generated from a previous step.

API Documentation​

Connections​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

Actions​

Create File Container​

Create Job Change​

Create Message Template​

Create Payment​

Create Supplier Invoice Request​

Create Supplier Invoice Request Attachment​

Create Table​

Create Time Off Request​

Create Worker Business Title Change​

Create Worker Time Block​

Delete Time Clock Event by ID​

Delete Worker Time Block​

Get Customer by ID​

Get Data Change by ID​

Get Event Attachments​

Get Event by ID​

Get Files by Container ID​

Get Invoice by ID​

Get Invoice PDF​

Get Message Template by ID​

Get Organization by ID​

Get Payment by ID​

Get Person by ID​

Get Staffing Worker by ID​

Get Staffing Workers​

Get Supplier Invoice Request Attachments​

Get Supplier Invoice Request by ID​

Get Table by ID​

Get Time Clock Event by ID​

Get Time Clock Events​

Get Time Off Balance by ID​

Get Time Off Details​

Get Worker Business Title Changes​

Get Worker by ID​

Get Worker Explicit Skills​

Get Worker Service Dates​

Initiate Job Change​

Initiate Organization Assignment Change​

List Data Changes​

List Events​

List Invoices​

List Message Templates​

List Organizations​

List People​

List Supplier Invoice Requests​

List Tables​

List Workers​

Raw Request​

Send Message​

Submit Supplier Invoice Request​

Update Message Template by ID​

Update Table by ID​

Update Time Clock Event by ID​

Update Worker Time Block​

Upload Files by Container ID​