Skip to main content

Workday (Beta) Connector

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

Connections

Workday OAuth 2.0 Connection

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

InputCommentsDefault
Authorize URLThe OAuth 2.0 Authorization URL for Workday. Replace <tenant_id> with your tenant ID.https://impl.workday.com/<tenant_id>/authorize
Token URLThe OAuth 2.0 Token URL for Workday. Replace <tenant_id> with your tenant ID.https://wd2-impl-services1.workday.com/ccx/oauth2/<tenant_id>/token
ScopesSpace separated list of scopes if needed
Client ID
Client secret
API URLThe base URL for the Workday API. Replace with your domain.https:///ccx

Actions

Delete Time Clock Events By ID

Deletes a time clock event with the specified ID.

InputCommentsDefault
Connection
Time Clock Event IdId of the time clock event
Debug RequestEnabling this flag will log out the current request.false

Delete Worker Time Block

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

InputCommentsDefault
Connection
Worker IdId of the worker
Worker Time Block IdId of the worker time block
Debug RequestEnabling this flag will log out the current request.false

Get Customer by ID

Retrieves customer by ID.

InputCommentsDefault
Connection
Customer IDThe ID of the customer to retrieve
Debug RequestEnabling this flag will log out the current request.false

Get Data Changes By ID

Data change is a Prism artifact that gives users the ability to easily load data into a Prism table so that they can use the table for analysis in downstream applications (Discovery Board, Reports, apps like Accounting Center/People Analytics) Data from multiple sources.

InputCommentsDefault
Connection
TenantThe tenant.
Data Change IDThe ID of the data change to retrieve
Debug RequestEnabling this flag will log out the current request.false

Get Event Attachments

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

InputCommentsDefault
Connection
Event IDThe ID of the event.
LimitThe maximum number of objects in a single response. The default is 20. The maximum is 100.
OffsetThe 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.
Debug RequestEnabling this flag will log out the current request.false

Get Event By ID

Retrieves the business process event with the specified ID.

InputCommentsDefault
Connection
Event IDThe ID of the event.
Debug RequestEnabling this flag will log out the current request.false

Get Files By Container ID

This resource returns all files for a file container. Returns file metadata about each file such as file name, size, checksum, and state. Possible file states are Timed Out, Uploading, Failed and Success. Files with a state of "Success" are ready for upload.

InputCommentsDefault
Connection
TenantThe tenant.
File Container IDThe ID of the file container to retrieve files for
Debug RequestEnabling this flag will log out the current request.false

Get Invoice By ID

Retrieves a customer invoice or adjustment with the specified ID.

InputCommentsDefault
Connection
Invoice IDThe ID of the invoice.
Debug RequestEnabling this flag will log out the current request.false

Get Invoice PDF

Retrieves printed customer invoice PDF documents.

InputCommentsDefault
Connection
Invoice PDF IDThe ID of the invoice PDF to retrieve.
Debug RequestEnabling this flag will log out the current request.false

Get Message Template By ID

Get a Message Template by ID

InputCommentsDefault
Connection
Message Template IDThe ID of the message template
Debug RequestEnabling this flag will log out the current request.false

Get Organization by ID

Retrieves an Organization by ID.

InputCommentsDefault
Connection
Organization IDThe ID of the organization.
Debug RequestEnabling this flag will log out the current request.false

Get Payment By ID

Retrieves a customer invoice payment with the specified ID.

InputCommentsDefault
Connection
Payment IDThe ID of the payment.
Debug RequestEnabling this flag will log out the current request.false

Get Person By ID

Retrieves a person with the specified ID. You can use a returned ID from 'List People' or 'Get Workers' to get more information about a specific person.

InputCommentsDefault
Connection
Person IdId of the person
Debug RequestEnabling this flag will log out the current request.false

Get Supplier Invoice Request Attachments

Retrieves all attachments associated with supplier invoices.

InputCommentsDefault
Connection
Supplier Invoice Request IDThe ID of the supplier invoice request.
LimitThe maximum number of objects in a single response. The default is 20. The maximum is 100.
OffsetThe 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.
Debug RequestEnabling this flag will log out the current request.false

Get Supplier Invoice Requests by ID

Retrieves the supplier invoice with the specified ID.

InputCommentsDefault
Connection
Supplier Invoice Request IDThe ID of the supplier invoice request.
Debug RequestEnabling this flag will log out the current request.false

Get Table By ID

This resource exposes the description of a table or dataset that the current user has permission on.

InputCommentsDefault
Connection
TenantThe tenant.
Table IDThe ID of the table.
Query ParamsQuery 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) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/tables/-id-
Debug RequestEnabling this flag will log out the current request.false

Get Time Clock Events

Retrieves a collection of time clock events. You can filter by the time clock events by worker and date range.

InputCommentsDefault
Connection
Query ParamsQuery parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123
Debug RequestEnabling this flag will log out the current request.false

Get Time Clock Events By ID

Retrieves a time clock event with the specified ID.

InputCommentsDefault
Connection
Time Clock Event IdId of the time clock event
Debug RequestEnabling this flag will log out the current request.false

Get Time Off Balance By ID

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

InputCommentsDefault
Connection
Balance IDThe ID of the balance.
Debug RequestEnabling this flag will log out the current request.false

Get Time Off Details

Retrieves the Time Off Entries for the specified worker ID. You can filter by date range, status, and type. If you don't specify query parameters, this method returns all Time Off Entries.

InputCommentsDefault
Connection
Worker IdId of the worker
LimitThe maximum number of objects in a single response. The default is 20. The maximum is 100.
OffsetThe 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 ParamsQuery 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) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/get-/workers/-ID-/timeOffDetails
Debug RequestEnabling this flag will log out the current request.false

Get Worker Business Title Changes

Retrieves a collection of workers and current staffing information.

InputCommentsDefault
Connection
Worker IdId of the worker
LimitThe maximum number of objects in a single response. The default is 20. The maximum is 100.
OffsetThe 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.
Debug RequestEnabling this flag will log out the current request.false

Get Worker By ID

Retrieves a collection of workers and current staffing information.

InputCommentsDefault
Connection
Worker IdId of the worker
Debug RequestEnabling this flag will log out the current request.false

Get Workers

Retrieves a collection of workers and current staffing information.

InputCommentsDefault
Connection
LimitThe maximum number of objects in a single response. The default is 20. The maximum is 100.
OffsetThe 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 ParamsQuery 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) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/workers
Debug RequestEnabling this flag will log out the current request.false

List Data Changes

Returns collection of data changes accessible by a user. User can pass offset and limit query params to get the list of data changes. The type of responses is based on "type" query parameter. The user gets a default response containing: id, name, displayName.

InputCommentsDefault
Connection
TenantThe tenant.
LimitThe maximum number of objects in a single response. The default is 20. The maximum is 100.
OffsetThe 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 ParamsQuery 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) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/dataChanges
Debug RequestEnabling this flag will log out the current request.false

List Events

Retrieves a collection of business process events based on the specified parameters. You must specify exactly one worker parameter. If a worker parameter is not specified, returns a blank response.

InputCommentsDefault
Connection
LimitThe maximum number of objects in a single response. The default is 20. The maximum is 100.
OffsetThe 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 ParamsQuery 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) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/events
Debug RequestEnabling this flag will log out the current request.false

List Invoices

Retrieves all customer invoices and adjustments.

InputCommentsDefault
Connection
Query ParamsQuery parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123
Debug RequestEnabling this flag will log out the current request.false

List Message Templates

Get Message Templates.

InputCommentsDefault
Connection
Query ParamsQuery parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123
Debug RequestEnabling this flag will log out the current request.false

List Organizations

Retrieves list of Organizations.

InputCommentsDefault
Connection
Query ParamsQuery parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123
Debug RequestEnabling this flag will log out the current request.false

List People

List all people in the Workday tenant. This action returns a list of all people in the Workday tenant.

InputCommentsDefault
Connection
LimitThe maximum number of objects in a single response. The default is 20. The maximum is 100.
OffsetThe 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 ParamsQuery 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) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v3/get-/people
Debug RequestEnabling this flag will log out the current request.false

List Supplier Invoice Requests

Retrieves all supplier invoices.

InputCommentsDefault
Connection
LimitThe maximum number of objects in a single response. The default is 20. The maximum is 100.
OffsetThe 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 ParamsQuery 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) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#accountsPayable/v1/get-/supplierInvoiceRequests
Debug RequestEnabling this flag will log out the current request.false

List Tables

The Tables resource represents a collection of tables created by the Workday REST API. You can only view the tables or datasets permitted by the security profile of the current user.

InputCommentsDefault
Connection
TenantThe tenant.
LimitThe maximum number of objects in a single response. The default is 20. The maximum is 100.
OffsetThe 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 ParamsQuery 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) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/tables
Debug RequestEnabling this flag will log out the current request.false

Post File Containers

Use this method to create a new fileContainer.

InputCommentsDefault
Connection
TenantThe tenant.
Debug RequestEnabling this flag will log out the current request.false

Post Files By Container ID

This resource loads the file into a file container. Creates temporary location to store file, and saves file metadata like size, checksum.

InputCommentsDefault
Connection
TenantThe tenant.
File Container IDThe ID of a Prism Analytics File Container
FileThe contents to write to a file. Binary data generated from a previous step.
Debug RequestEnabling this flag will log out the current request.false

Post Job Changes

Creates a job change instance with the specified data.

InputCommentsDefault
Connection
Worker IdId of the worker
Supervisory Organization IdThe supervisory organization for the worker as of the effective date.
Job Change Reason IdId of the reason used in a Change Job business process.
Move Managers TeamIndicates whether teams reporting to the Manager moved with them during the Change Job Event.false
Effective DateThe date this business process takes effect.
Proposed OrganizationsOrganizations with staffing behavior assigned to the position as a result of this event.
Instance IdId of the instance
Instance HrefA link to the instance
Instance DescriptorA preview of the instance
Debug RequestEnabling this flag will log out the current request.false

Post Message Templates

Create a new message template.

InputCommentsDefault
Connection
Created By IDCreator ID
Email DetailDetails for the email.
Push DetailDetails for the push notification.
Message Template NameName of the message template.
Reference IdThe Reference ID to use for lookups within our Workday Web Services
Template InactiveWhether the template is inactive.true
Template DescriptorDescriptor for the template.
Template IdId for the template.
Additional FieldsAdditional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#connect/v2/post-/messageTemplates
Debug RequestEnabling this flag will log out the current request.false

Post Payment

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

InputCommentsDefault
Connection
Remit From Customer IDThe ID of the customer from which the payment is being remitted.
Ready to Auto ApplyIndicates whether the payment is ready to be automatically applied.true
ReferenceA reference for the payment.
Transaction NumberThe transaction number for the payment.
AmountThe amount of the payment.
Type IDThe ID of the payment type.
Payment DateThe date of the payment.
Company IDThe ID of the company.
MemoThe memo.
Payment DescriptorA descriptor for the payment.
Payment IDThe ID of the payment.
Debug RequestEnabling this flag will log out the current request.false

Post Supplier Invoice Requests

Request Supplier Invoice Requests.

InputCommentsDefault
Connection
Currency IDThe ID of the currency.
Company IDThe ID of the company.
Tax AmountThe tax amount.
Requester IDThe ID of the requester.
Control Total AmountThe control total amount.
Payment Terms IDThe ID of the payment terms.
Reference Type IDThe ID of the reference type.
MemoThe memo.
Supplier Invoice IDThe ID of the supplier invoice.
Supplier Invoice DescriptorThe descriptor of the supplier invoice.
Additional FieldsAdditional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#accountsPayable/v1/post-/supplierInvoiceRequests for more information.
Debug RequestEnabling this flag will log out the current request.false

Post Supplier Invoice Requests Attachments

Creates attachments for the specified supplier invoice.

InputCommentsDefault
Connection
Supplier Invoice Request IDThe ID of the supplier invoice request.
File LengthFile length of the attachment.
Content Type IDID of the content type.
File NameName of the file.
Supplier Invoice Request Attachment DescriptorDescriptor of the attachment.
Supplier Invoice Request Attachment IDID of the attachment.
Debug RequestEnabling this flag will log out the current request.false

Post Table

Use this method to create a new table with the specified name.

InputCommentsDefault
Connection
TenantThe tenant.
Display NameThe display name of the table.
DescriptionThe description of the table.
DocumentationThe documentation of the table.
Enable For AnalysisWhether the table is enabled for analysis.false
NameThe name of the table.
TagsThe tags of the table. An array of objects with id and name.
FieldsThe fields of the table. An array of objects. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/post-/tables for more information.
Debug RequestEnabling this flag will log out the current request.false

Post Time Off Request

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

InputCommentsDefault
Connection
Worker IdId of the worker
Action IDThe ID of the action.
Overall Business Process IDThe ID of the overall business process.
DaysThe days for which the time off request is being made. An array of objects. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/post-/workers/-ID-/requestTimeOff for more information.
Time Off CommentThe comment on the time off entry.
Transaction Status IdThe id of the transaction status.
Time Off AttachmentsThe attachments for the time off request.
Time Off For IdThe Id of the time off for. It could be another business process Id if this is a sub-process
Debug RequestEnabling this flag will log out the current request.false

Post Worker Business Title Change

Create a new business title change for the specified worker.

InputCommentsDefault
Connection
Worker IdId of the worker
Proposed Business TitleThe 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 IdId of the instance
Instance HrefA link to the instance
Instance DescriptorA preview of the instance
Debug RequestEnabling this flag will log out the current request.false

Post Worker Time Block

Creates a worker time block for the specified worker.

InputCommentsDefault
Connection
Worker IdId of the worker
Do Not BillThe non-billable flag for a reported time block.false
CommentThe comment associated with the reported time block.
Instance IdId of the instance
Instance DescriptorA preview of the instance
Additional FieldsAdditional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/post-/workers/-ID-/workerTimeBlock
Debug RequestEnabling this flag will log out the current request.false

Raw Request

Send raw HTTP request to Workday

InputCommentsDefault
Connection
URLInput 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.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA 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.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf 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 CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Send Message

Send a message.

InputCommentsDefault
Connection
Sender Override IDAn ID to override the sender displayed Icon.
Communication IDGroup communication ID
Email DetailDetails for the email.
ContactsContacts to send the message to. This should be an array of contacts.
Message Template IDThe ID of the message template
Notification Type IDThe ID of the notification type.
Push DetailDetails for the push notification.
Debug RequestEnabling this flag will log out the current request.false

Submit Supplier Invoice Request

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

InputCommentsDefault
Connection
Supplier Invoice Request IDThe ID of the supplier invoice request.
Supplier Invoice Instance IDThe ID of the supplier invoice instance to submit for approval.
Supplier Invoice Instance DescriptorThe descriptor of the supplier invoice instance to submit for approval.
Debug RequestEnabling this flag will log out the current request.false

Update Message Template By ID

Update a Message Template by ID.

InputCommentsDefault
Message Template IDThe ID of the message template
Connection
Created By IDCreator ID
Email DetailDetails for the email.
Push DetailDetails for the push notification.
Message Template NameName of the message template.
Reference IdThe Reference ID to use for lookups within our Workday Web Services
Template InactiveWhether the template is inactive.
Template DescriptorDescriptor for the template.
Template IdId for the template.
Additional FieldsAdditional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#connect/v2/post-/messageTemplates
Debug RequestEnabling this flag will log out the current request.false

Update Table By ID

Use this method to edit an existing table with the specified name.

InputCommentsDefault
Table IDThe ID of the table.
Connection
TenantThe tenant.
Display NameThe display name of the table.
DescriptionThe description of the table.
DocumentationThe documentation of the table.
Enable For AnalysisWhether the table is enabled for analysis.
NameThe name of the table.
TagsThe tags of the table. An array of objects with id and name.
FieldsThe fields of the table. An array of objects. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/put-/tables/-id- for more information.
Debug RequestEnabling this flag will log out the current request.false

Update Time Clock Events By ID

Updates the time clock event for the specified ID. Replaces the existing time clock event with the specified data (proceed with caution).

InputCommentsDefault
Connection
Time Clock Event IdId of the time clock event
Clock Event Date TimeThe date time for a time clock event
Clock Event Time Zone IdThe time zone id for a time clock event
Clock Event Override RateThe override rate for a time clock event
Reference IdThe Reference ID to use for lookups within our Workday Web Services
Clock Event Time Entry Code IdThe time entry code id for a time clock event
Clock Event Project Plan Task IdThe project plan task id for a time clock event
Clock Event Project IdThe project id for a time clock event
Clock Event CommentThe comment associated with the time clock event
Additional FieldsAdditional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/put-/timeClockEvents/-ID-
Instance DescriptorA preview of the instance
Instance HrefA link to the instance
Instance IdId of the instance
Debug RequestEnabling this flag will log out the current request.false

Update Worker Time Block

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

InputCommentsDefault
Worker Time Block IdId of the worker time block
Connection
Worker IdId of the worker
Do Not BillThe non-billable flag for a reported time block.
CommentThe comment associated with the reported time block.
Instance IdId of the instance
Instance DescriptorA preview of the instance
Additional FieldsAdditional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/post-/workers/-ID-/workerTimeBlock See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/patch-/workers/-ID-/workerTimeBlock/-subresourceID-
Debug RequestEnabling this flag will log out the current request.false