Skip to main content
workday icon

Workday (Beta) Connector

Sourcenpm · v0.3.1API DocsConnector Changelog

Description​

Beta Component

This component is a work in progress and has not yet been verified against a live Workday account. It was built to current component standards and tested against mocked API responses to deliver the highest quality possible without live access. Beta components may receive changes that are not backwards compatible, so review the component changelog before upgrading to a new version. Feedback on functionality, and confirmation that actions work against a live account, is encouraged.

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​

key: workdayOAuth2Connection

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).
  • For Run WQL Query and the Changed WQL Query Rows trigger: the System scope on the API client, and, for the Workday account that authorizes the connection, access to the Workday Query Language security domain and security access to the data sources and fields the query reads. See Workday's WQL overview.

Setup Steps​

The API client is registered in the Workday portal. Registration also displays the values required to configure the connection.

  1. Log into the Workday Portal

    • Use valid Workday Org admin credentials.
    • Format: https://impl.workday.com/wday/authgwy/<tenant_name>/login.htmld

  2. Search and Register

    • From the Search menu for the Workday categories, select Register API Client and click Register.

  3. 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.
    • Access Token Type: Select Bearer.
    • Redirect URL: Enter the redirect URL: https://oauth2.prismatic.io/callback
    • Scope: Select the required services from the dropdown list. Include System to run WQL queries.

  4. 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:

  • API URL (required): The host of the Workday REST API Endpoint shown in View API Clients, followed by /ccx, such as https://wd2-impl-services1.workday.com/ccx.
  • Authorize URL (required): The Authorization Endpoint shown in View API Clients, in the form https://{host}/{tenant}/authorize.
  • Token URL (required): The Token Endpoint shown in View API Clients, in the form https://{host}/ccx/oauth2/{tenant}/token.
  • Client ID (required): The client ID shown after registering the API client.
  • Client Secret (required): The client secret paired with the client ID, shown once at registration.
  • Scopes (optional): Space-separated OAuth 2.0 scopes. Leave blank to use the functional areas selected when the API client was registered.
InputNotesExample
API URL

The Workday API base URL: the host of the Workday REST API Endpoint shown in View API Clients, followed by /ccx, in the form https://{host}/ccx.

https://wd2-impl-services1.workday.com/ccx
Authorize URL

The Authorization Endpoint shown for the API client in View API Clients, in the form https://{host}/{tenant}/authorize.

https://impl.workday.com/acme/authorize
Client ID

The client ID shown after registering the API client with the Register API Client task in Workday.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Client Secret

The client secret paired with the client ID, shown once when the API client is registered.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Scopes

Space-separated OAuth 2.0 scopes to request. Leave blank to use the functional areas selected when the API client was registered.

Token URL

The Token Endpoint shown for the API client in View API Clients, in the form https://{host}/ccx/oauth2/{tenant}/token.

https://wd2-impl-services1.workday.com/ccx/oauth2/acme/token

Refresh Token​

key: workdayRefreshTokenConnection

The Refresh Token connection authenticates with an API Client for Integrations and a refresh token generated by a Workday administrator for an Integration System User (ISU). No browser sign-in is needed, and access tokens are requested and renewed automatically.

Prerequisites​

Before configuring the connection, the following are required:

  • Administrator access to the Workday tenant to register an API Client for Integrations and generate refresh tokens.
  • An Integration System User (ISU) with access to the data the integration reads, including any custom reports run through Get RaaS Report.
  • For Get RaaS Report: the Report as a Service scope on the API client, and the report shared with the ISU. See Workday's RaaS Python client for the same setup.
  • For Run WQL Query and the Changed WQL Query Rows trigger: the System scope on the API client, access to the Workday Query Language security domain for the ISU, and security access to the data sources and fields the query reads. See Workday's WQL overview.

Setup Steps​

  1. Register the API client

    • In Workday, search for the Register API Client for Integrations task.
    • Enter a Client Name.
    • Under Scope (Functional Areas), select the functional areas the integration reads. Include Report as a Service to run RaaS reports and System to run WQL queries.
    • Review the refresh-token expiry setting against the tenant's security policy.
    • Click OK and note the Client ID and Client Secret. The client secret is shown only once.

  2. Generate a refresh token

    • From the API client's related actions, select API Client > Manage Refresh Tokens for Integrations.
    • Select the ISU in Workday Account and click OK.
    • Select Generate New Refresh Token, click OK, and copy the Refresh Token.

  3. Find the REST API Endpoint

    • Run the View API Clients task.
    • Note the Workday REST API Endpoint, in the form https://<host>/ccx/api/v1/<tenant>, and the Token Endpoint.

Configure the Connection​

Create a connection of type Refresh Token and provide the following inputs:

  • REST API Endpoint (required): The Workday REST API Endpoint from View API Clients, such as https://wd2-impl-services1.workday.com/ccx/api/v1/acme. The API base URL, tenant and token URL are derived from it.
  • Client ID (required): The client ID of the API Client for Integrations.
  • Client Secret (required): The client secret paired with the client ID.
  • Refresh Token (required): The refresh token generated for the ISU. The connection never updates the stored value. If Workday returns a different refresh token, it is used for later token requests in the same running process and a warning is logged; if later executions then fail to authenticate, generate a new refresh token and update the connection.
  • Token URL (optional): Leave blank to use https://<host>/ccx/oauth2/<tenant>/token. Enter the Token Endpoint from View API Clients only if it differs.

Verify Connection​

Run the Verify Connection action with the connection. It requests a new access token and, when a Report URL is entered, reads that report to confirm the ISU can access it.

InputNotesExample
Client ID

The client ID of the API Client for Integrations, shown after registering it in Workday.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Client Secret

The client secret paired with the client ID, shown once when the API Client for Integrations is registered.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Refresh Token

The refresh token generated for the Integration System User with the Manage Refresh Tokens for Integrations task in Workday.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
REST API Endpoint

The Workday REST API Endpoint shown for the API client in View API Clients, in the form https://<host>/ccx/api/v1/<tenant>. The API base URL, tenant and token URL are derived from it.

https://wd2-impl-services1.workday.com/ccx/api/v1/acme
Token URL

Overrides the token URL derived from the REST API Endpoint. Leave blank unless the Token Endpoint in View API Clients differs from https://<host>/ccx/oauth2/<tenant>/token.

https://wd2-impl-services1.workday.com/ccx/oauth2/acme/token

Triggers​

Changed RaaS Report Rows​

Retrieves existing and ongoing rows for a specified Workday RaaS report. Load history once, check for changes on a schedule, or both. | key: raasReportPollingTrigger

InputNotesExample
Connection

The Workday connection to use.

Look-back Date

The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each record from that date on once, with no inputs ignored.

2026-01-01
Prompts

Static prompt values for the report as key-value pairs, sent on every recurrence. Keys are the prompt XML aliases. Do not include the Watermark Prompt.

{"Effective_as_of_Date": "2026-10-01"}
Record Key Field

The Report_Entry column, by XML alias, that identifies a row, such as an employee ID. Used to detect rows already delivered.

Employee_ID
Report URL

The report URL from Web Services > View URLs for the report in Workday. Must be on the same host as the connection. The trigger always requests format=json.

https://wd2-impl-services1.workday.com/ccx/service/customreport2/acme/ISU_Orgvue/People_Report
Watermark Format

The format of the value sent to the Watermark Prompt. Match the prompt's type in the report.

dateTime
Watermark Prompt

The XML alias of the report prompt that receives the window start. Build the report so this prompt keeps only rows entered or changed on or after that time.

Updated_Since

The Changed RaaS Report Rows trigger runs a Workday custom report exposed as a web service (RaaS) on a schedule and emits the Report_Entry rows that are new or changed since the previous recurrence.

The trigger does not know which rows changed on its own. The report must have a date or date-time prompt, named in Watermark Prompt, that keeps only rows entered or changed on or after the value the trigger sends. Change detection is only as accurate as that filter: a report that ignores the prompt, or filters on a date that does not move when a row changes, misses changes or repeats rows.

How It Works​

  1. The trigger runs on the configured schedule and records the time each recurrence starts.
  2. It requests the Report URL with format=json, the static Prompts, and the Watermark Prompt set to the window start: 5 minutes before the previous recurrence started. Watermark Format sends the value as a UTC date-time (2026-10-15T12:00:00Z) or a UTC date (2026-10-15). The report URL must be on the connection's Workday host.
  3. Each returned row is fingerprinted from its Record Key Field value and its full contents. Rows whose fingerprint was already returned by the previous recurrence are skipped, so the 5-minute overlap is not delivered twice, while a changed row at the same key is delivered again.
  4. The trigger stores the recurrence start time and the fingerprints of the rows it saw, and returns the remaining rows. A fingerprint is a 16-character hash, never row contents, and up to 10,000 are kept. When a window returns more than 10,000 distinct rows, the recurrence logs a warning with the window size and the limit, and keeps the fingerprints of the last 10,000 rows in the order the report returns them; sort the report ascending by the watermark field so those are the most recent. A row whose fingerprint was dropped is delivered again if the next window returns it unchanged; with the Date watermark format the next window rereads the whole day, so on a day with more than 10,000 rows the dropped rows are delivered on every recurrence. A report column whose value changes on every run also delivers its row every time.

A row missing the Record Key Field column fails the recurrence with an error that lists the row's columns. With a Watermark Format of Date, every recurrence re-reads the whole day and relies on the fingerprints to skip rows already delivered.

Initial Sync

An initial sync seeds a complete starting state, but this trigger has no input that narrows which changes are reported, so no input is ignored while it runs. It begins on the first recurrence, when the trigger has no stored state and a Look-back Date (YYYY-MM-DD) is set: the Watermark Prompt receives the start of that day (UTC) and every returned row is delivered exactly once. Left empty, there is no sync: the first recurrence reads the last 5 minutes, records what it saw, and delivers nothing.

The window has no fixed upper bound, so a row changed mid-sync is swept into the sync. The sync reads the whole report in a single recurrence, whether or not batching is on. The trigger then stores the time that recurrence started, and the first incremental recurrence resumes 5 minutes before it, skipping rows already delivered; nothing in the payload marks the handoff.

Report URL, Prompts, Watermark Format, and Record Key Field all still apply during the sync.

Batching

Batching is enabled per flow on this trigger: each changed record is dispatched as its own execution, or grouped by the configured batch size. Batch size and batch concurrency can both be overridden per instance. Raising concurrency increases the request volume sent to Workday.

To turn it on, select the flow's trigger, open the Flow control tab, and switch on Enable Batching. Under Batch Size, keep Trigger default or choose Custom batch size. Batch Concurrency is optional; leave it blank for no batch-level limit.

With batching off a downstream step reads body.data.changed. With batching on that field does not exist: each execution receives one { "changeType": "changed", "record": ... } item, or an array of them when the batch size is greater than 1. Any step reading the older shape must be updated before batching is enabled, or it breaks the moment the switch is flipped. Because batching is enabled per flow, that change is scoped to the flow rather than to the component or to other flows using the same trigger.

Returned Data​

With batching off, the trigger returns an object under body.data with one array, changed, holding the report's Report_Entry rows. Column names are the report's XML aliases.

Example Response
{
  "data": {
    "changed": [
      {
        "Employee_ID": "21001",
        "Worker": "Logan McNeil",
        "Business_Title": "Vice President, Human Resources",
        "Supervisory_Organization": "Human Resources (Logan McNeil)",
        "Last_Updated": "2026-10-15T11:58:42.000-07:00"
      }
    ]
  }
}

With batching on, each execution receives one row tagged with how it changed, or an array of such items when the batch size is greater than 1. The changed array is not part of this shape.

Batched Item
{
  "changeType": "changed",
  "record": {
    "Employee_ID": "21001",
    "Worker": "Logan McNeil",
    "Business_Title": "Vice President, Human Resources",
    "Supervisory_Organization": "Human Resources (Logan McNeil)",
    "Last_Updated": "2026-10-15T11:58:42.000-07:00"
  }
}

Fields shown are representative. The full response object includes additional properties.

Example Payload for Changed RaaS Report Rows⤓
Loading…

Changed WQL Query Rows​

Retrieves existing and ongoing rows for a specified Workday WQL query. Load history once, check for changes on a schedule, or both. | key: wqlQueryPollingTrigger

InputNotesExample
Connection

The Workday connection to use.

Date Field

The name of the date or date-time column in each returned row that the query compares to {{lastPolledAt}}, such as approvalDate. Must be selected in the query and must be the same field the WHERE clause compares to {{lastPolledAt}} with >=. The trigger continues from the newest value of this field it has seen.

approvalDate
Look-back Date

The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each record from that date on once, with no inputs ignored.

2026-01-01
Overlap Minutes

The number of minutes each recurrence starts before the newest Date Field value already seen, to catch rows saved late with an older date, such as backdated transactions. Leave empty when the Date Field is a value Workday sets when the row is saved or changed. Rows already delivered are skipped.

60
Query

The WQL query to run. Must contain {{lastPolledAt}}, which is replaced with the window start as a quoted UTC date-time literal. Compare it against a date-time field that moves when a row is entered or changed, following the pattern WHERE <dateTimeField> >= {{lastPolledAt}}. Which fields exist, and their types, depend on the data source.

SELECT workdayID, <dateTimeField> FROM <dataSource> WHERE <dateTimeField> >= {{lastPolledAt}}
Record Key Field

The field that identifies a row, such as workdayID. Must be selected in the query. Used to detect rows already delivered.

workdayID
Tenant

The Workday tenant to query. Leave blank with the Refresh Token connection to use the tenant from its REST API Endpoint. Required with the OAuth 2.0 connection.

acme

The Changed WQL Query Rows trigger runs a Workday Query Language (WQL) query on a schedule and emits the rows that are new or changed since the previous recurrence.

The Workday setup that WQL requires (API client scope, security domain and data access) is listed in the prerequisites of the OAuth 2.0 and Refresh Token connections.

The query must contain the {{lastPolledAt}} placeholder; a recurrence fails with an error, before calling Workday, when it is missing. The trigger replaces it with the window start as a quoted UTC date-time literal, such as '2026-10-15 11:55:00Z', the format the WQL WHERE reference documents for date comparisons. Compare it against a date-time field that moves when a row is entered or changed, and enter that field's name in Date Field. The query must select it, and it must be the field the WHERE clause compares to {{lastPolledAt}} with >=. Each row's value of it is what moves the trigger forward.

Example Query Pattern
SELECT workdayID, <dateTimeField> FROM <dataSource> WHERE <dateTimeField> >= {{lastPolledAt}}

Which date or date-time fields exist depends on the data source. entryMoment is a FROM clause argument in WQL (FROM allWorkers (entryMoment="2019-01-01 12:30:25Z")), not a field, so it cannot be compared in WHERE. Replace <dataSource> with a data source and <dateTimeField> with one of its date-time fields; field names and types depend on the data source, so confirm a field's type before filtering on it. Change detection is only as accurate as the field the query filters on.

How It Works​

  1. The trigger runs on the configured schedule and reads the Date Field from each row the query returns.
  2. It replaces {{lastPolledAt}} with the window start, the newest Date Field value seen so far, and reads every page of the query by limit and offset. The comparison is inclusive (>=), so the rows at that value come back and are not delivered twice. With Overlap Minutes set, the window starts that many minutes earlier. The first recurrence has no such value yet and starts 5 minutes before it runs (or at the Look-back Date). Tenant falls back to the tenant in the connection's REST API Endpoint.
  3. Each row is fingerprinted from its Record Key Field value and its full contents. WQL rows contain only the selected fields, so the key field must be in the SELECT list; a row without it fails the recurrence with an error. Rows at the window start that an earlier recurrence already returned are skipped, while a changed row at the same key is delivered again.
  4. The trigger stores the newest Date Field value and the fingerprints of the rows at it, and returns the remaining rows. The window start never moves back (the overlap only widens the query, never the stored value), and it never moves to the clock: a recurrence that returns no rows leaves it where it was, and a row whose Date Field is missing or is not a date does not move it. A recurrence that returns rows but none with a usable Date Field fails with an error. A fingerprint is a 16-character hash, never row contents. Up to 10,000 are kept, the same number of rows Workday caches for a query. Delivery is at least once: a selected field whose value changes on every run delivers its row every time.

Workday caches at most 10,000 rows of a query for paging. A window matching more fails with an error instead of delivering part of it. On the first recurrence with a Look-back Date, choose a later date or narrow the query. Once the trigger has stored state, the Look-back Date no longer applies, so narrow the query's WHERE clause or run the trigger more often.

Overlap Minutes

A row saved late with a Date Field value older than the newest one already seen, such as a backdated transaction, is not returned by a later window. To catch those, set Overlap Minutes: each recurrence then starts that many minutes before the newest Date Field value seen, and a late row is delivered once if its date falls inside that margin. A row older than the margin is still missed, so choose a margin at least as long as the longest backdating you expect. Leave it empty when the Date Field is a value Workday sets when the row is saved or changed, since nothing can then arrive with an older value.

The trade-off is volume: a larger margin re-reads more rows on every recurrence, but none are delivered twice. The trigger keeps the fingerprint of every row inside the margin, and the 10,000-row limit applies to the whole window, margin included, so a margin that makes the window match more rows fails the recurrence with the error described above. A row inside the margin whose content changed is delivered again. The overlap applies from the recurrence after the first one that stores a position; the first window, whether from a Look-back Date, the 5-minute baseline, or a trigger resumed from earlier state, starts where it always did.

A query longer than 2,047 characters is sent to Workday in a request that cannot be paged. If it matches more rows than one response holds, the recurrence fails with an error; shorten the query or narrow its WHERE clause.

Initial Sync

An initial sync seeds a complete starting state, but this trigger has no input that narrows which changes are reported, so no input is ignored while it runs. It begins on the first recurrence, when the trigger has no stored state and a Look-back Date (YYYY-MM-DD) is set: {{lastPolledAt}} becomes the start of that day (UTC) and every returned row is delivered exactly once. Left empty, there is no sync: the first recurrence reads the last 5 minutes, records what it saw, and delivers nothing.

The window has no fixed upper bound, so a row changed mid-sync is swept into the sync. The sync reads the whole window in a single recurrence, whether or not batching is on. The trigger then stores the newest Date Field value the sync returned, and the first incremental recurrence resumes from it, skipping rows already delivered; nothing in the payload marks the handoff.

Query, Record Key Field, Date Field, Overlap Minutes, and Tenant all still apply during the sync, and the 10,000-row limit applies to the sync window too.

Batching

Batching is enabled per flow on this trigger: each changed record is dispatched as its own execution, or grouped by the configured batch size. Batch size and batch concurrency can both be overridden per instance. Raising concurrency increases the request volume sent to Workday.

To turn it on, select the flow's trigger, open the Flow control tab, and switch on Enable Batching. Under Batch Size, keep Trigger default or choose Custom batch size. Batch Concurrency is optional; leave it blank for no batch-level limit.

With batching off a downstream step reads body.data.changed. With batching on that field does not exist: each execution receives one { "changeType": "changed", "record": ... } item, or an array of them when the batch size is greater than 1. Any step reading the older shape must be updated before batching is enabled, or it breaks the moment the switch is flipped. Because batching is enabled per flow, that change is scoped to the flow rather than to the component or to other flows using the same trigger.

Returned Data​

With batching off, the trigger returns an object under body.data with one array, changed, holding query rows keyed by the selected fields. Reference fields carry descriptor and id.

Example Response
{
  "data": {
    "changed": [
      {
        "workdayID": "c4f78be1a8f14da0ab49ce1162348a5e",
        "approvalDate": "2026-10-15"
      }
    ]
  }
}

With batching on, each execution receives one row tagged with how it changed, or an array of such items when the batch size is greater than 1. The changed array is not part of this shape.

Batched Item
{
  "changeType": "changed",
  "record": {
    "workdayID": "c4f78be1a8f14da0ab49ce1162348a5e",
    "approvalDate": "2026-10-15"
  }
}

Fields shown are representative. The full response object includes additional properties.

Example Payload for Changed WQL Query Rows⤓
Loading…

New Event Steps​

Retrieves existing and newly created business process event steps from Workday, emitting new event steps only and never changes to existing ones. Load history once, check for new event steps on a schedule, or both. | key: newEventStepsPollingTrigger

InputNotesExample
Business Process

Workday IDs of the business process types whose event steps are included. Leave empty to include all.

3cb0fdb7e3354a05b0a5e1c8a9d0f4b2
Connection

The Workday connection to use.

Look-back Date

The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each record from that date on once, with no inputs ignored.

2026-01-01
Step Type

Workday IDs of the step types to include. Leave empty to include all.

d9e4223e446c11de98360015c5e6daf6

The New Event Steps trigger checks Workday on a schedule for business process event steps (see the Workday REST Services Business Process API) created since the previous recurrence. It emits new event steps only: event steps carry a creation date but no modification date, so changes to existing steps (completion, reassignment, a new due date) are not reported.

How It Works​

  1. The trigger runs on the configured schedule and records the time each recurrence starts.
  2. It requests GET /businessProcess/v1/eventSteps with createdOnOrAfter set to the day before the previous recurrence's UTC date. The filter is date-only and Workday dates follow the tenant's time zone, so the extra day covers any offset from UTC. Business Process and Step Type narrow the request when set.
  3. It reads every page by limit and offset until the reported total is reached. A window needing more than 1,000 pages fails with an error rather than delivering part of it.
  4. Steps whose ID was already returned by the previous recurrence are skipped. The trigger stores the recurrence start time and the IDs of steps created on or after the next window's start date, so the stored set holds about two days of steps, and returns the remaining steps. Up to 10,000 IDs are kept. When more than 10,000 steps fall in that range, the recurrence logs a warning with the count and the limit and keeps the IDs of the most recently created steps; a step whose ID was dropped is delivered again if the next window returns it.

Results are secured by Workday: only steps from events the integration user can view are returned.

Initial Sync

An initial sync seeds a complete starting state. Business Process and Step Type still narrow the steps it reports, so no input is ignored while it runs. It begins on the first recurrence, when the trigger has no stored state and a Look-back Date (YYYY-MM-DD) is set: createdOnOrAfter is that date and every returned step is delivered exactly once. Left empty, there is no sync: the first recurrence reads steps created since the previous day, records their IDs, and delivers nothing.

The window has no fixed upper bound, so a step created mid-sync is swept into the sync. The sync reads the whole window in a single recurrence, whether or not batching is on. The trigger then stores the time that recurrence started, and the first incremental recurrence resumes from the day before it, skipping steps already delivered; nothing in the payload marks the handoff.

Business Process and Step Type still apply during the sync.

Batching

Batching is enabled per flow on this trigger: each changed record is dispatched as its own execution, or grouped by the configured batch size. Batch size and batch concurrency can both be overridden per instance. Raising concurrency increases the request volume sent to Workday.

To turn it on, select the flow's trigger, open the Flow control tab, and switch on Enable Batching. Under Batch Size, keep Trigger default or choose Custom batch size. Batch Concurrency is optional; leave it blank for no batch-level limit.

With batching off a downstream step reads body.data.created. With batching on that field does not exist: each execution receives one { "changeType": "created", "record": ... } item, or an array of them when the batch size is greater than 1. Any step reading the older shape must be updated before batching is enabled, or it breaks the moment the switch is flipped. Because batching is enabled per flow, that change is scoped to the flow rather than to the component or to other flows using the same trigger.

Returned Data​

With batching off, the trigger returns an object under body.data with one array, created, holding event step records.

Example Response
{
  "data": {
    "created": [
      {
        "id": "8f2a6c1e9b7d4e3fa1c05d2b6e4f7a90",
        "descriptor": "Review Time Off Request: Logan McNeil",
        "creationDate": "2026-10-15",
        "dueDate": "2026-10-17",
        "stepType": {
          "id": "d9e4223e446c11de98360015c5e6daf6",
          "descriptor": "Approval"
        },
        "businessProcess": {
          "id": "3cb0fdb7e3354a05b0a5e1c8a9d0f4b2",
          "descriptor": "Request Time Off"
        },
        "status": {
          "id": "d9e41a8c446c11de98360015c5e6daf6",
          "descriptor": "Awaiting Action"
        }
      }
    ]
  }
}

With batching on, each execution receives one event step tagged with how it changed, or an array of such items when the batch size is greater than 1. The created array is not part of this shape.

Batched Item
{
  "changeType": "created",
  "record": {
    "id": "8f2a6c1e9b7d4e3fa1c05d2b6e4f7a90",
    "descriptor": "Review Time Off Request: Logan McNeil",
    "creationDate": "2026-10-15",
    "dueDate": "2026-10-17"
  }
}

Fields shown are representative. The full response object includes additional properties.

Example Payload for New Event Steps⤓
Loading…

Data Sources​

Select Data Change​

A picklist of data changes in the Workday Prism Analytics tenant. | key: selectDataChange | type: picklist

InputNotesExample
Connection

The Workday connection to use.

Tenant

The Workday tenant name used in API paths.

acme
Example Payload for Select Data Change⤓
Loading…

Select Event​

A picklist of business process events in the Workday tenant. | key: selectEvent | type: picklist

InputNotesExample
Connection

The Workday connection to use.

Example Payload for Select Event⤓
Loading…

Select Invoice​

A picklist of customer invoices in the Workday tenant. | key: selectInvoice | type: picklist

InputNotesExample
Connection

The Workday connection to use.

Example Payload for Select Invoice⤓
Loading…

Select Message Template​

A picklist of message templates in the Workday tenant. | key: selectMessageTemplate | type: picklist

InputNotesExample
Connection

The Workday connection to use.

Example Payload for Select Message Template⤓
Loading…

Select Organization​

A picklist of organizations in the Workday tenant. | key: selectOrganization | type: picklist

InputNotesExample
Connection

The Workday connection to use.

Organization Type ID

Workday ID of the organization type to list, such as a supervisory or cost center organization type. Workday documents that organization requests must provide an organization type.

3cb0fdb7e3354a05b0a5e1c8a9d0f4b2
Example Payload for Select Organization⤓
Loading…

Select Person​

A picklist of people in the Workday tenant. | key: selectPerson | type: picklist

InputNotesExample
Connection

The Workday connection to use.

Example Payload for Select Person⤓
Loading…

Select Supplier Invoice Request​

A picklist of supplier invoice requests in the Workday tenant. | key: selectSupplierInvoiceRequest | type: picklist

InputNotesExample
Connection

The Workday connection to use.

Example Payload for Select Supplier Invoice Request⤓
Loading…

Select Table​

A picklist of tables in the Workday Prism Analytics tenant. | key: selectTable | type: picklist

InputNotesExample
Connection

The Workday connection to use.

Tenant

The Workday tenant name used in API paths.

acme
Example Payload for Select Table⤓
Loading…

Select Worker​

A picklist of workers in the Workday tenant. | key: selectWorker | type: picklist

InputNotesExample
Connection

The Workday connection to use.

Example Payload for Select Worker⤓
Loading…

Actions​

Create File Container​

Creates a new file container. | key: postFileContainers

InputNotesExample
Connection

The Workday connection to use.

Tenant

The Workday tenant name used in API paths.

acme
Example Payload for Create File Container⤓
Loading…

Create Job Change​

Creates a job change instance with the specified data. | key: postJobChanges

InputNotesExample
Connection

The Workday connection to use.

Effective Date

The date this business process takes effect. Format: YYYY-MM-DD.

2022-01-01
Instance Descriptor

Human-readable preview label for the referenced instance.

Logan McNeil
Instance Href

Direct API link pointing to the referenced instance.

Instance ID

Identifies the Workday instance being referenced.

3aa5550b7fe348b98d7b5741afc65534
Job Change Reason ID

Identifies the reason used in a Change Job business process.

123$456
Move Managers Team

When true, also moves subordinate teams to the new manager.

false
Proposed Organizations

Organizations with staffing behavior assigned to the position as a result of this event. Each row identifies one organization.

Supervisory Organization ID

Supervisory organization assigned to the worker as of the effective date.

123$456
Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Create Job Change⤓
Loading…

Create Message Template​

Creates a new message template. | key: postMessageTemplates

InputNotesExample
Connection

The Workday connection to use.

Created By ID

Identifies the user who created the record.

3aa5550b7fe348b98d7b5741afc65534
Email Detail

Email content for the message: Name, Subject, Body, and Reply To.

Extra Body

Additional body fields to include in the request as a JSON object. See Workday API documentation for more information.

{
  "lastUpdated": "2024-06-08T07:00:00.000Z",
  "usageCount": "12",
  "createdOn": "2024-06-08T07:00:00.000Z",
  "lastUpdatedBy": {
    "id": "58571c1e23784c869d949f4d63421f0c"
  }
}
Message Template Name

Display name given to the message template.

Benefits Enrollment Reminder
Notification Type ID

Identifies the notification type, which determines where the template can be used.

1f3a5c7e9b0d42f4a6c8e0b2d4f6a8c0
Push Detail

Mobile push notification content for the message: Message, Redirect URL, and ID.

Reference ID

Reference ID used for lookups within Workday Web Services.

Employee_ID=21001
Template Descriptor

Human-readable descriptor for the template.

Benefits Enrollment Reminder
Template ID

Optional identifier to assign to the template, sent as its id in the request body.

6e0f4a2b8c1d4e3fa9b7c5d3e1f2a4b6
Template Inactive

When true, marks the template as inactive.

true
Example Payload for Create Message Template⤓
Loading…

Create Payment​

Creates a single customer invoice payment header instance with the specified data. | key: postPayment

InputNotesExample
Additional Fields

Additional optional fields: includes Ready to Auto Apply, Reference, Transaction Number, Memo, and Payment Descriptor.

Amount

Monetary amount for the payment.

1250.00
Company ID

Identifies the Workday company.

cb550da820584750aae8f807882fa79a
Connection

The Workday connection to use.

Payment Date

Date the payment was made. Format: YYYY-MM-DD.

2024-06-01
Payment ID

Optional identifier to assign to the payment on creation.

5c3a1e9f7d2b4a6c8e0f1a3b5c7d9e1f
Remit From Customer ID

Identifies the customer remitting the payment.

8f2e4d6c1b3a49e7a5c0d9f8e7b6a5c4
Type ID

Identifies the payment type.

Payment_Type_ID=Check
Example Payload for Create Payment⤓
Loading…

Create Supplier Invoice Request​

Creates a supplier invoice request with the specified data. | key: postSupplierInvoiceRequests

InputNotesExample
Amounts

Currency, tax amount, and control total amount.

Company ID

Identifies the Workday company for the supplier invoice request.

cb550da820584750aae8f807882fa79a
Connection

The Workday connection to use.

Extra Body

Additional body fields to include in the request as a JSON object. See Workday API documentation for more information.

{
  "lines": [
    {
      "unitCost": "250.00",
      "internalMemo": "Approved by facilities manager",
      "worktags": [
        {
          "id": "a1b2c3d4e5f60718293a4b5c6d7e8f90",
          "descriptor": "Cost Center: 41600 Facilities"
        }
      ],
      "itemDescription": "Office chairs",
      "splits": [
        {
          "percent": "100",
          "billable": true,
          "memo": "Full allocation to facilities",
          "quantity": "4",
          "amount": "1000.00",
          "worktags": [
            {
              "id": "a1b2c3d4e5f60718293a4b5c6d7e8f90",
              "descriptor": "Cost Center: 41600 Facilities"
            }
          ],
          "id": "e3c1f2a4b5d64789a0b1c2d3e4f5a6b7",
          "descriptor": "Split 1"
        }
      ],
      "order": "1",
      "billable": true,
      "splitBy": {
        "id": "9007db06140249838746074289b3ab5e"
      },
      "quantity": "4",
      "extendedAmount": "1000.00",
      "spendCategory": {
        "id": "c8934da88ef1418da4a6dc049acb3e4b"
      },
      "unitOfMeasure": {
        "id": "89ba1d2320c64ea490a0837459804422"
      },
      "memo": "Ergonomic office chairs",
      "serviceLine": false,
      "item": {
        "id": "724ed690753146efbf4fd0bc4a7bdc2f"
      },
      "id": "7c9d8e6f5a4b43c2b1a0f9e8d7c6b5a4",
      "descriptor": "Line 1"
    }
  ],
  "statutoryInvoiceType": {
    "id": "d13a219779454d70887556d17754f81c"
  },
  "suppliersInvoiceNumber": "INV-2024-0612",
  "referenceNumber": "PO-000456",
  "invoiceReceivedDate": "2024-06-08T07:00:00.000Z",
  "freightAmount": "100.00",
  "handlingCode": {
    "id": "eb95c26cb57641c9a30631c0cdfbf95b"
  },
  "shipToAddress": {
    "id": "1decbabeb2234113976a7275cb7b03d1"
  },
  "remitToConnection": {
    "id": "3bcb3df4ab164524bc39d84ffa6f870f"
  }
}
Invoice Date

The date the supplier invoice request is created. Accepts an ISO 8601 date (YYYY-MM-DD) or date-time.

2024-06-08
Memo

Free-text memo attached to the transaction.

Payment for June services
Payment Terms ID

Identifies the payment terms that apply to the invoice.

25ecdd7d7e2346f5842a8ef7b6d65c63
Reference Type ID

Identifies the reference type for the invoice.

0226117a5b894ff8be12a2d6c88ecd8a
Requester ID

Identifies the worker who requested the invoice.

3aa5550b7fe348b98d7b5741afc65534
Supplier ID

Identifies the supplier for the supplier invoice request.

3c9baa38493e4dfabb829f3897598ab7
Supplier Invoice Descriptor

Human-readable descriptor for the supplier invoice.

Supplier Invoice: SI-000123
Supplier Invoice ID

Identifies the supplier invoice.

767ca0bfbd6e46e29b7621524748aa04
Example Payload for Create Supplier Invoice Request⤓
Loading…

Create Supplier Invoice Request Attachment​

Creates attachments for the specified supplier invoice. | key: postSupplierInvoiceRequestsAttachments

InputNotesExample
Attachment Details

File length, file name, and descriptor for the attachment.

Connection

The Workday connection to use.

Content Type ID

Identifies the MIME content type of the attachment.

c8a3e5f1d2b44a6e9f0b7c1d2e3f4a5b
File

The file to attach to the supplier invoice request. Binary data generated from a previous step.

ZXhhbXBsZQ==
Supplier Invoice Request Attachment ID

Identifies the attachment on the supplier invoice request.

389a01b915e14595be3c3ec2822089e8
Supplier Invoice Request ID

Identifies the supplier invoice request.

b6389b0a7604433fb4e05b88251b0d07
Example Payload for Create Supplier Invoice Request Attachment⤓
Loading…

Create Table​

Creates a new table with the specified name. | key: postTable

InputNotesExample
Additional Fields

Additional optional fields: includes Description, Documentation, and Enable for Analysis.

Connection

The Workday connection to use.

Display Name

User-facing display name shown in Prism Analytics.

Worker Headcount
Fields

The fields of the table. An array of objects. See Workday API documentation for more information.

[
  {
    "name": "Hire_Date",
    "ordinal": 1,
    "comments": "Date the worker was hired.",
    "parseFormat": "yyyy-MM-dd",
    "type": {
      "name": "Date",
      "id": "Schema_Field_Type=Date"
    },
    "precision": 0,
    "scale": 0,
    "businessObject": {
      "id": "9c1e3a5c7e2f48b0d2f4a6c8e0a2c4e6",
      "descriptor": "Worker"
    },
    "context": {
      "id": "1d3f5b7d9f4a40c2e4a6c8e0b2d4f6a8",
      "descriptor": "Hire Date"
    },
    "displayName": "Hire Date",
    "defaultValue": "2024-01-01",
    "fieldId": "Hire_Date",
    "required": false,
    "externalId": false
  }
]
Name

Internal name used to reference the table via API.

Worker_Headcount
Tags

Labels used to categorize and find the table. Each row identifies one tag.

Tenant

The Workday tenant name used in API paths.

acme
Example Payload for Create Table⤓
Loading…

Create Time Off Request​

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

InputNotesExample
Business Process Parameters

Action, parent process, transaction status, comment, attachments, and target instance for the business process.

Connection

The Workday connection to use.

Days

The days for which the time off request is being made. An array of objects. See Workday API documentation for more information.

[
  {
    "date": "2024-06-08T07:00:00.000Z",
    "start": "2024-06-08T07:00:00.000Z",
    "position": {
      "id": "9f3f3b7329154567b202c469209c4773",
      "descriptor": "Senior Software Engineer"
    },
    "end": "2024-06-08T07:00:00.000Z",
    "reason": {
      "id": "7715acc1ec5c4cab881cf161eedecea7"
    }
  }
]
Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Create Time Off Request⤓
Loading…

Create Worker Business Title Change​

Creates a new business title change for the specified worker. | key: postWorkerBusinessTitleChange

InputNotesExample
Connection

The Workday connection to use.

Instance Descriptor

Human-readable preview label for the referenced instance.

Logan McNeil
Instance Href

Direct API link pointing to the referenced instance.

Instance ID

Identifies the Workday instance being referenced.

3aa5550b7fe348b98d7b5741afc65534
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.

Senior Product Manager
Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Create Worker Business Title Change⤓
Loading…

Create Worker Time Block​

Creates a worker time block for the specified worker. | key: postWorkerTimeBlock

InputNotesExample
Comment

Free-text comment attached to the reported time block.

Connection

The Workday connection to use.

Do Not Bill

When true, marks the time block as non-billable.

false
Extra Body

Additional body fields to include in the request as a JSON object. See Workday API documentation for more information.

{
  "customWorktag07": {
    "id": "edb6a868245948108794fd638296e287"
  },
  "customWorktag01": {
    "id": "7ddca655c6d141139421993237a51615"
  },
  "customWorktag13": {
    "id": "f13eea6188db48dab70b4cc602ec970f"
  },
  "customWorktag15": {
    "id": "71551f2559ab45bd894353356327d1e7"
  },
  "customWorktag08": {
    "id": "51d40b89b17e4259b9405e5b9ec27bdb"
  },
  "customWorktag14": {
    "id": "ac294074acb74927aea072afa3aa8042"
  },
  "customWorktag02": {
    "id": "f348c0731f494b17bccb1c3677a54088"
  },
  "customWorktag04": {
    "id": "e098bc767c344c07aea9c19c3f0285ea"
  },
  "customWorktag09": {
    "id": "8f17e1c0b8d04845aa6d9af47158d85c"
  },
  "customWorktag06": {
    "id": "7f633b0064c8475ca38f6600b6c2ba6b"
  },
  "customWorktag05": {
    "id": "7e88c8c97b964159b0d34e7e63405b32"
  },
  "customWorktag03": {
    "id": "c7563a211566406ba8cf4b003c5ae41f"
  },
  "customWorktag10": {
    "id": "263623fc84cf4c7f8e8fddb908f2be50"
  },
  "customWorktag11": {
    "id": "08974bf6b3164f4fb818fd0c8eb79dc7"
  },
  "customWorktag12": {
    "id": "32688e78d6f949949cbf765ec8bf9ccb"
  },
  "customOrganization10": {
    "id": "bd7cbd05e5184404bd23da9c4780e9fa"
  },
  "customOrganization06": {
    "id": "c21a98df7a3f45a18af328c062d89347"
  },
  "appropriation": {
    "id": "5fc9eada8c9941e785401804706fafff"
  },
  "customOrganization02": {
    "id": "927ef357d263458987ed850016744fec"
  },
  "allocationPool": {
    "id": "67e47f1ed95b4c899889051908254bed"
  },
  "customOrganization03": {
    "id": "6a735c7a7ba04f489926c88a98d63a19"
  },
  "customOrganization04": {
    "id": "e838e6e1605f45e59695ceef6e5f38f3"
  },
  "customOrganization05": {
    "id": "f6ee416e77944fd6bd899f339fb649ae"
  },
  "customOrganization01": {
    "id": "baf36640051f48af8ebed4399a56984a"
  },
  "customOrganization07": {
    "id": "2071ae6a2fe74c8c9dcd3ac3fd1ab9e7"
  },
  "customOrganization08": {
    "id": "181549113d154d5e8c504d8e3eda6bde"
  },
  "customOrganization09": {
    "id": "add691e6f6a34a16b9602316b1057e28"
  },
  "program": {
    "id": "3ca5bafd904b4ec6b9f3bd23b8e31950"
  },
  "jobProfile": {
    "id": "11123be5aa7244388e772a8827621d1f"
  },
  "costCenter": {
    "id": "43c1f23afb1c41df8def56b9f6da8d1d"
  },
  "location": {
    "id": "49d80d18b03a4324a03d68f7fe55a452"
  },
  "grant": {
    "id": "b0bdb52a8eba412c9e7c7e439f62e6ae"
  },
  "businessUnit": {
    "id": "c03bf4aa5b90490897077ff545112f63"
  },
  "region": {
    "id": "e8439e98ac0541cda18fdd672f2f585d"
  },
  "position": {
    "id": "8c3c94cabd664260b16077e1dd56aaaf"
  },
  "fund": {
    "id": "cc287900aa4a4c22a0486a101d6e4d78"
  },
  "reportedQuantity": "8",
  "gift": {
    "id": "b85c9c1cb6124d5eb2d9b83513cae519"
  },
  "status": {
    "id": "562c9774cc8d4b049e1ff8daf64f21ac"
  },
  "unit": {
    "id": "599330c7e61e41e59d3bf446daee8d92"
  },
  "worker": {
    "id": "3ecf777071f14e1c861073fe6b35690d"
  },
  "calendarDate": "2024-06-01T07:00:00.000Z",
  "timeEntryCode": {
    "id": "5c5a72e5658244629fbc518891ad5e29"
  },
  "projectRole": {
    "id": "848431263b594196bff57da192988322"
  },
  "overrideRate": "3",
  "projectPlanPhase": {
    "id": "99a0270269d94b4099996adf4a00462f"
  },
  "outReason": {
    "id": "25feff6c52bb43f098886904bd161d4f"
  },
  "project": {
    "id": "17a4a68190c644aa8d96b7a09d3b87dc"
  },
  "projectPlanTask": {
    "id": "88f01e603ed849c2b4a32591b4f9a9d3"
  },
  "currency": {
    "id": "e4930a3e1f744384979d18a80819e220"
  }
}
Instance Descriptor

Human-readable preview label for the referenced instance.

Logan McNeil
Instance ID

Identifies the Workday instance being referenced.

3aa5550b7fe348b98d7b5741afc65534
Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Create Worker Time Block⤓
Loading…

Delete Time Clock Event by ID​

Deletes a time clock event with the specified ID. | key: deleteTimeClockEventsById

InputNotesExample
Connection

The Workday connection to use.

Time Clock Event ID

Identifies the time clock event record.

8a0c2e4a6c7d49f1b3d5f7b9d1f3a5c7
Example Payload for Delete Time Clock Event by ID⤓
Loading…

Delete Worker Time Block​

Deletes a worker time block with the specified ID for the specified worker. | key: deleteWorkerTimeBlock

InputNotesExample
Connection

The Workday connection to use.

Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Worker Time Block ID

Identifies the worker's reported time block.

4e6a8c0e2a5b47d9f1b3d5f7a9c1e3b5
Example Payload for Delete Worker Time Block⤓
Loading…

Get Customer by ID​

Retrieves a customer by ID. | key: getCustomerById

InputNotesExample
Connection

The Workday connection to use.

Customer ID

Identifies the customer account.

8f2e4d6c1b3a49e7a5c0d9f8e7b6a5c4
Example Payload for Get Customer by ID⤓
Loading…

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. | key: getDataChangesById

InputNotesExample
Connection

The Workday connection to use.

Data Change ID

Identifies the Prism Analytics data change transaction.

7a9c1e3f5b2d44a6c8e0a2c4e6a8c0e2
Tenant

The Workday tenant name used in API paths.

acme
Example Payload for Get Data Change by ID⤓
Loading…

Get Event Attachments​

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

InputNotesExample
Connection

The Workday connection to use.

Event ID

Identifies the business process event.

5b1f8c2d3e4a4b6c9d7e8f0a1b2c3d4e
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Example Payload for Get Event Attachments⤓
Loading…

Get Event by ID​

Retrieves the business process event with the specified ID. | key: getEventById

InputNotesExample
Connection

The Workday connection to use.

Event ID

Identifies the business process event.

5b1f8c2d3e4a4b6c9d7e8f0a1b2c3d4e
Example Payload for Get Event by ID⤓
Loading…

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. | key: getFilesByContainerId

InputNotesExample
Connection

The Workday connection to use.

File Container ID

Identifies the file container whose files will be retrieved.

3b5d7f9a1c2e44b6d8f0a2c4e6b8d0f2
Tenant

The Workday tenant name used in API paths.

acme
Example Payload for Get Files by Container ID⤓
Loading…

Get Invoice by ID​

Retrieves a customer invoice or adjustment with the specified ID. | key: getInvoiceById

InputNotesExample
Connection

The Workday connection to use.

Invoice ID

Identifies the customer invoice to retrieve.

e1c7a3f5b9d24c6e8a0f2b4d6c8e0a2f
Example Payload for Get Invoice by ID⤓
Loading…

Get Invoice PDF​

Retrieves printed customer invoice PDF documents. | key: getInvoicePdf

InputNotesExample
Connection

The Workday connection to use.

Invoice PDF ID

Identifies the invoice PDF resource to retrieve.

e1c7a3f5b9d24c6e8a0f2b4d6c8e0a2f
Example Payload for Get Invoice PDF⤓
Loading…

Get Message Template by ID​

Retrieves a message template by ID. | key: getMessageTemplateById

InputNotesExample
Connection

The Workday connection to use.

Message Template ID

Identifies the Connect message template.

6e0f4a2b8c1d4e3fa9b7c5d3e1f2a4b6
Example Payload for Get Message Template by ID⤓
Loading…

Get Organization by ID​

Retrieves an organization by ID. | key: getOrganizationById

InputNotesExample
Connection

The Workday connection to use.

Organization ID

Identifies the Workday organization.

cb550da820584750aae8f807882fa79a
Organization Type ID

Optional organization type used to filter the Organization ID dropdown. Not sent with this request.

3cb0fdb7e3354a05b0a5e1c8a9d0f4b2
Example Payload for Get Organization by ID⤓
Loading…

Get Payment by ID​

Retrieves a customer invoice payment with the specified ID. | key: getPaymentById

InputNotesExample
Connection

The Workday connection to use.

Payment ID

Identifies the customer payment record.

5c3a1e9f7d2b4a6c8e0f1a3b5c7d9e1f
Example Payload for Get Payment by ID⤓
Loading…

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. | key: getPersonById

InputNotesExample
Connection

The Workday connection to use.

Person ID

Unique identifier for a person in the Workday tenant.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Get Person by ID⤓
Loading…

Get RaaS Report​

Retrieves the output of a Workday custom report exposed as a web service (RaaS). | key: getRaasReport

InputNotesExample
Connection

The Workday connection to use.

Format

The output format Workday returns the report in.

json
Prompts

Prompt values for the report as key-value pairs. Keys are the prompt XML aliases, which can differ from the labels shown in Workday. For a single-instance prompt by WID, use a key such as Organization!WID.

{"Effective_as_of_Date": "2026-10-01"}
Report URL

The report URL from Web Services > View URLs for the report in Workday. Must be on the same host as the connection. Any format parameter in the URL is replaced by the Format input.

https://wd2-impl-services1.workday.com/ccx/service/customreport2/acme/ISU_Orgvue/People_Report
Example Payload for Get RaaS Report⤓
Loading…

Get Staffing Worker by ID​

Retrieves a worker with the specified ID and current staffing information from the Staffing service. | key: getStaffingWorkerById

InputNotesExample
Connection

The Workday connection to use.

Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Get Staffing Worker by ID⤓
Loading…

Get Staffing Workers​

Retrieves a collection of workers and current staffing information from the Staffing service. | key: getStaffingWorkers

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs. See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Example Payload for Get Staffing Workers⤓
Loading…

Get Supplier Invoice Request Attachments​

Retrieves all attachments for the specified supplier invoice request. | key: getSupplierInvoiceRequestAttachments

InputNotesExample
Connection

The Workday connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Supplier Invoice Request ID

Identifies the supplier invoice request.

b6389b0a7604433fb4e05b88251b0d07
Example Payload for Get Supplier Invoice Request Attachments⤓
Loading…

Get Supplier Invoice Request by ID​

Retrieves the supplier invoice request with the specified ID. | key: getSupplierInvoiceRequestsById

InputNotesExample
Connection

The Workday connection to use.

Supplier Invoice Request ID

Identifies the supplier invoice request.

b6389b0a7604433fb4e05b88251b0d07
Example Payload for Get Supplier Invoice Request by ID⤓
Loading…

Get Table by ID​

Retrieves the description of a table or dataset the current user has permission to access. | key: getTableById

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs. See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Table ID

Identifies the Prism Analytics table.

0c2e4a6c8e1f43a5b7d9f1b3d5f7a9c1
Tenant

The Workday tenant name used in API paths.

acme
Example Payload for Get Table by ID⤓
Loading…

Get Time Clock Event by ID​

Retrieves a time clock event with the specified ID. | key: getTimeClockEventsById

InputNotesExample
Connection

The Workday connection to use.

Time Clock Event ID

Identifies the time clock event record.

8a0c2e4a6c7d49f1b3d5f7b9d1f3a5c7
Example Payload for Get Time Clock Event by ID⤓
Loading…

Get Time Clock Events​

Retrieves a collection of time clock events. Supports filtering by worker and date range. | key: getTimeClockEvents

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs. See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Example Payload for Get Time Clock Events⤓
Loading…

Get Time Off Balance by ID​

Retrieves the specified balance of all absence plan and leave of absence types for the specified balance ID. | key: getTimeOffBalanceById

InputNotesExample
Balance ID

Identifies the time-off balance to retrieve.

f27c2f31526e49688d2631e98d63e56c
Connection

The Workday connection to use.

Example Payload for Get Time Off Balance by ID⤓
Loading…

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. | key: getTimeOffDetails

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs. See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Get Time Off Details⤓
Loading…

Get Worker Business Title Changes​

Retrieves a collection of business title changes for the specified worker. | key: getWorkerBusinessTitleChanges

InputNotesExample
Connection

The Workday connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Get Worker Business Title Changes⤓
Loading…

Get Worker by ID​

Retrieves a worker and current staffing information by ID. | key: getWorkerById

InputNotesExample
Connection

The Workday connection to use.

Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Get Worker by ID⤓
Loading…

Get Worker Explicit Skills​

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

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs. See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Get Worker Explicit Skills⤓
Loading…

Get Worker Service Dates​

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

InputNotesExample
Connection

The Workday connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Get Worker Service Dates⤓
Loading…

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. | key: initiateJobChange

InputNotesExample
Connection

The Workday connection to use.

Effective Date

The effective date of the job change. Format: ISO 8601 date-time (YYYY-MM-DDTHH:mm:ss.sssZ).

2024-06-01T07:00:00.000Z
Extra Body

Additional body fields to include in the request as a JSON object. See Workday API documentation for more information.

{
  "template": {
    "id": "5c7e9a1b3d5f47a9b1c3e5a7c9e1b3d5"
  }
}
Job ID

Workday ID of the worker's position before the effective date. Retrieve using GET /values/jobChangesGroup/jobs with the worker query parameter.

2a4c6e8a0c3e45f7b9d1f3a5c7e9b1d3
Location ID

Workday ID of the new location for the worker as of the effective date. Retrieve using GET /values/jobChangesGroup/locations.

98915f9116884d2e95027cfc506d4760
Reason ID

Workday ID of the change job reason. Retrieve using GET /values/jobChangesGroup/reason.

6b8d0f2b4d5f47a9c1e3a5c7e9a1c3e5
Supervisory Organization ID

Workday ID of the supervisory organization for the worker as of the effective date. Retrieve using GET /values/jobChangesGroup/supervisoryOrganization.

f5074d9b65654ba68d2c4fafb5a1e4fd
Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Initiate Job Change⤓
Loading…

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. | key: initiateOrganizationAssignmentChange

InputNotesExample
Connection

The Workday connection to use.

Effective Date

The effective date of the organization assignment change. Format: ISO 8601 date-time (YYYY-MM-DDTHH:mm:ss.sssZ).

2024-06-01T07:00:00.000Z
Extra Body

Additional body fields to include in the request as a JSON object. Company, cost center, region, and other organizations are set after initiation with the PATCH /organizationAssignmentChanges/{ID} subresource endpoints. See Workday API documentation for more information.

{
  "descriptor": "Organization assignment change for Logan McNeil"
}
Job ID

Workday ID of the worker's job (position) to change. Retrieve using GET /values/organizationAssignmentChangesGroup/jobs with the worker query parameter.

2a4c6e8a0c3e45f7b9d1f3a5c7e9b1d3
Position ID

Workday ID of the worker's position as of the effective date. Retrieve using GET /values/organizationAssignmentChangesGroup/positions.

2a4c6e8a0c3e45f7b9d1f3a5c7e9b1d3
Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Example Payload for Initiate Organization Assignment Change⤓
Loading…

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. | key: listDataChanges

InputNotesExample
Connection

The Workday connection to use.

Data Change Name

The name of the data change to return. Either Data Change Type or Data Change Name must be set.

Monthly_Headcount_Load
Data Change Type

How much data change detail to return: Summary returns the data change summary, Full adds the description, application, categories, tags, and mappings. Either Data Change Type or Data Change Name must be set.

summary
Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs. See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Tenant

The Workday tenant name used in API paths.

acme
Example Payload for List Data Changes⤓
Loading…

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. | key: listEvents

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs. See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Example Payload for List Events⤓
Loading…

List Invoices​

Retrieves all customer invoices and adjustments. | key: listInvoices

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Example Payload for List Invoices⤓
Loading…

List Message Templates​

Retrieves message templates. | key: listMessageTemplates

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Example Payload for List Message Templates⤓
Loading…

List Organizations​

Retrieves a list of organizations. | key: listOrganizations

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Organization Type ID

Workday ID of the organization type to list, such as a supervisory or cost center organization type. Workday documents that organization requests must provide an organization type.

3cb0fdb7e3354a05b0a5e1c8a9d0f4b2
Pagination

Page-size and starting-position controls for the result collection.

Example Payload for List Organizations⤓
Loading…

List People​

Retrieves all people in the Workday tenant. | key: listPeople

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs. See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Example Payload for List People⤓
Loading…

List Supplier Invoice Requests​

Retrieves all supplier invoice requests. | key: listSupplierInvoiceRequests

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs. See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Example Payload for List Supplier Invoice Requests⤓
Loading…

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. | key: listTables

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs. See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Tenant

The Workday tenant name used in API paths.

acme
Example Payload for List Tables⤓
Loading…

List Workers​

Retrieves a collection of workers and current staffing information. | key: getWorkers

InputNotesExample
Connection

The Workday connection to use.

Extra Parameters

Query parameters to be used in the request. This should be a list of key-value pairs. See optional (QUERY-STRING PARAMETERS) in the Workday API documentation.

{"worker": "3aa5550b7fe348b98d7b5741afc65534"}
Fetch All

When true, automatically fetches all pages of results using pagination. Offset is ignored and Limit sets the page size (default 100).

false
Pagination

Page-size and starting-position controls for the result collection.

Example Payload for List Workers⤓
Loading…

Raw Request​

Sends a raw HTTP request to Workday. | key: rawRequest

InputNotesExample
Connection

The Workday connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

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.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
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
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/accountsPayable/v1/supplierInvoiceRequests), The base URL is already included (https://{host}/ccx). For example, to connect to https://{host}/ccx/accountsPayable/v1/supplierInvoiceRequests, only /accountsPayable/v1/supplierInvoiceRequests is entered in this field.

/accountsPayable/v1/supplierInvoiceRequests
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false
Example Payload for Raw Request⤓
Loading…

Run WQL Query​

Runs a Workday Query Language (WQL) query and returns the matching rows. | key: runWqlQuery

InputNotesExample
Connection

The Workday connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination. Reads up to the 10,000 rows Workday caches for a query; Offset is ignored and Limit sets the page size.

false
Pagination

Page-size and starting-row controls for the query results.

Query

The WQL query to run. Use the LIMIT clause to cap the total rows returned.

SELECT worker, fullName FROM allWorkers
Tenant

The Workday tenant to query. Leave blank with the Refresh Token connection to use the tenant from its REST API Endpoint. Required with the OAuth 2.0 connection.

acme
Example Payload for Run WQL Query⤓
Loading…

Send Message​

Sends a message. | key: sendMessage

InputNotesExample
Communication ID

Identifier of the Workday communication group.

4d6f8a0c2e1b43a5b7d9f1a3c5e7b9d1
Connection

The Workday connection to use.

Message Details

Email, push notification, and recipient details for the message.

Message Template ID

Identifies the Connect message template.

6e0f4a2b8c1d4e3fa9b7c5d3e1f2a4b6
Notification Type ID

Identifies the notification type used for delivery.

1f3a5c7e9b0d42f4a6c8e0b2d4f6a8c0
Sender Override ID

Overrides the icon displayed for the sender.

9a7c5e3b1d2f4a6c8e0b2d4f6a8c0e2b
Example Payload for Send Message⤓
Loading…

Submit Supplier Invoice Request​

Submits a supplier invoice instance with the specified ID for approval. | key: submitSupplierInvoiceRequest

InputNotesExample
Connection

The Workday connection to use.

Supplier Invoice Instance Descriptor

Human-readable descriptor for the supplier invoice instance being submitted.

Supplier Invoice Request: SIR-000123
Supplier Invoice Instance ID

Identifies the supplier invoice instance to submit for approval.

53f807ae49df49389687cabd4ba24d14
Supplier Invoice Request ID

Identifies the supplier invoice request.

b6389b0a7604433fb4e05b88251b0d07
Example Payload for Submit Supplier Invoice Request⤓
Loading…

Update Message Template by ID​

Updates a message template by ID. | key: updateMessageTemplateById

InputNotesExample
Connection

The Workday connection to use.

Created By ID

Identifies the user who created the record.

3aa5550b7fe348b98d7b5741afc65534
Email Detail

Email content for the message: Name, Subject, Body, and Reply To.

Extra Body

Additional body fields to include in the request as a JSON object. See Workday API documentation for more information.

{
  "lastUpdated": "2024-06-08T07:00:00.000Z",
  "usageCount": "12",
  "createdOn": "2024-06-08T07:00:00.000Z",
  "lastUpdatedBy": {
    "id": "58571c1e23784c869d949f4d63421f0c"
  }
}
Message Template ID

Identifies the Connect message template.

6e0f4a2b8c1d4e3fa9b7c5d3e1f2a4b6
Message Template Name

Display name given to the message template.

Benefits Enrollment Reminder
Notification Type ID

Identifies the notification type, which determines where the template can be used.

1f3a5c7e9b0d42f4a6c8e0b2d4f6a8c0
Push Detail

Mobile push notification content for the message: Message, Redirect URL, and ID.

Reference ID

Reference ID used for lookups within Workday Web Services.

Employee_ID=21001
Template Descriptor

Human-readable descriptor for the template.

Benefits Enrollment Reminder
Template ID

Optional identifier to assign to the template, sent as its id in the request body.

6e0f4a2b8c1d4e3fa9b7c5d3e1f2a4b6
Template Inactive

When true, marks the template as inactive.

Example Payload for Update Message Template by ID⤓
Loading…

Update Table by ID​

Updates an existing table with the specified name. | key: updateTableById

InputNotesExample
Additional Fields

Additional optional fields: includes Description, Documentation, and Enable for Analysis.

Connection

The Workday connection to use.

Display Name

User-facing display name shown in Prism Analytics.

Worker Headcount
Fields

The fields of the table. An array of objects. See Workday API documentation for more information.

[
  {
    "name": "Hire_Date",
    "ordinal": 1,
    "comments": "Date the worker was hired.",
    "parseFormat": "yyyy-MM-dd",
    "type": {
      "name": "Date",
      "id": "Schema_Field_Type=Date"
    },
    "precision": 0,
    "scale": 0,
    "businessObject": {
      "id": "9c1e3a5c7e2f48b0d2f4a6c8e0a2c4e6",
      "descriptor": "Worker"
    },
    "context": {
      "id": "1d3f5b7d9f4a40c2e4a6c8e0b2d4f6a8",
      "descriptor": "Hire Date"
    },
    "displayName": "Hire Date",
    "defaultValue": "2024-01-01",
    "fieldId": "Hire_Date",
    "required": false,
    "externalId": false
  }
]
Name

Internal name used to reference the table via API.

Worker_Headcount
Table ID

Identifies the Prism Analytics table.

0c2e4a6c8e1f43a5b7d9f1b3d5f7a9c1
Tags

Labels used to categorize and find the table. Each row identifies one tag.

Tenant

The Workday tenant name used in API paths.

acme
Example Payload for Update Table by ID⤓
Loading…

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. | key: updateTimeClockEventsById

InputNotesExample
Assignment IDs

Write-action IDs that associate a record with related entities (offices, departments, tags, sources, etc.).

Clock Event Comment

Free-text comment attached to the time clock event.

Clocked in from the warehouse kiosk
Clock Event Override Rate

Optional rate that overrides the default pay rate for this event.

45.00
Connection

The Workday connection to use.

Extra Body

Additional body fields to include in the request as a JSON object. See Workday API documentation for more information.

{
  "businessUnit": {
    "id": "0658921d364a454181f5799ae226ae5b"
  },
  "costCenter": {
    "id": "b9df597186c7447a8125f83ebf48a847"
  },
  "customWorktag08": {
    "id": "1516be812ac047bb82bcf7a519162158"
  },
  "worker": {
    "id": "ef500cf977be4cea9035c04fe748a229"
  }
}
Instance Descriptor

Human-readable preview label for the referenced instance.

Logan McNeil
Instance Href

Direct API link pointing to the referenced instance.

Instance ID

Identifies the Workday instance being referenced.

3aa5550b7fe348b98d7b5741afc65534
Reference ID

Reference ID used for lookups within Workday Web Services.

Employee_ID=21001
Time Clock Event ID

Identifies the time clock event record.

8a0c2e4a6c7d49f1b3d5f7b9d1f3a5c7
Example Payload for Update Time Clock Event by ID⤓
Loading…

Update Worker Time Block​

Updates the worker time block for the specified worker with the specified data in the request body. | key: updateWorkerTimeBlock

InputNotesExample
Comment

Free-text comment attached to the reported time block.

Connection

The Workday connection to use.

Do Not Bill

When true, marks the time block as non-billable.

Extra Body

Additional body fields to include in the request as a JSON object. See Workday API documentation for more information.

{
  "customWorktag07": {
    "id": "edb6a868245948108794fd638296e287"
  },
  "customWorktag01": {
    "id": "7ddca655c6d141139421993237a51615"
  },
  "customWorktag13": {
    "id": "f13eea6188db48dab70b4cc602ec970f"
  },
  "customWorktag15": {
    "id": "71551f2559ab45bd894353356327d1e7"
  },
  "customWorktag08": {
    "id": "51d40b89b17e4259b9405e5b9ec27bdb"
  },
  "customWorktag14": {
    "id": "ac294074acb74927aea072afa3aa8042"
  },
  "customWorktag02": {
    "id": "f348c0731f494b17bccb1c3677a54088"
  },
  "customWorktag04": {
    "id": "e098bc767c344c07aea9c19c3f0285ea"
  },
  "customWorktag09": {
    "id": "8f17e1c0b8d04845aa6d9af47158d85c"
  },
  "customWorktag06": {
    "id": "7f633b0064c8475ca38f6600b6c2ba6b"
  },
  "customWorktag05": {
    "id": "7e88c8c97b964159b0d34e7e63405b32"
  },
  "customWorktag03": {
    "id": "c7563a211566406ba8cf4b003c5ae41f"
  },
  "customWorktag10": {
    "id": "263623fc84cf4c7f8e8fddb908f2be50"
  },
  "customWorktag11": {
    "id": "08974bf6b3164f4fb818fd0c8eb79dc7"
  },
  "customWorktag12": {
    "id": "32688e78d6f949949cbf765ec8bf9ccb"
  },
  "customOrganization10": {
    "id": "bd7cbd05e5184404bd23da9c4780e9fa"
  },
  "customOrganization06": {
    "id": "c21a98df7a3f45a18af328c062d89347"
  },
  "appropriation": {
    "id": "5fc9eada8c9941e785401804706fafff"
  },
  "customOrganization02": {
    "id": "927ef357d263458987ed850016744fec"
  },
  "allocationPool": {
    "id": "67e47f1ed95b4c899889051908254bed"
  },
  "customOrganization03": {
    "id": "6a735c7a7ba04f489926c88a98d63a19"
  },
  "customOrganization04": {
    "id": "e838e6e1605f45e59695ceef6e5f38f3"
  },
  "customOrganization05": {
    "id": "f6ee416e77944fd6bd899f339fb649ae"
  },
  "customOrganization01": {
    "id": "baf36640051f48af8ebed4399a56984a"
  },
  "customOrganization07": {
    "id": "2071ae6a2fe74c8c9dcd3ac3fd1ab9e7"
  },
  "customOrganization08": {
    "id": "181549113d154d5e8c504d8e3eda6bde"
  },
  "customOrganization09": {
    "id": "add691e6f6a34a16b9602316b1057e28"
  },
  "program": {
    "id": "3ca5bafd904b4ec6b9f3bd23b8e31950"
  },
  "jobProfile": {
    "id": "11123be5aa7244388e772a8827621d1f"
  },
  "costCenter": {
    "id": "43c1f23afb1c41df8def56b9f6da8d1d"
  },
  "location": {
    "id": "49d80d18b03a4324a03d68f7fe55a452"
  },
  "grant": {
    "id": "b0bdb52a8eba412c9e7c7e439f62e6ae"
  },
  "businessUnit": {
    "id": "c03bf4aa5b90490897077ff545112f63"
  },
  "region": {
    "id": "e8439e98ac0541cda18fdd672f2f585d"
  },
  "position": {
    "id": "8c3c94cabd664260b16077e1dd56aaaf"
  },
  "fund": {
    "id": "cc287900aa4a4c22a0486a101d6e4d78"
  },
  "reportedQuantity": "8",
  "gift": {
    "id": "b85c9c1cb6124d5eb2d9b83513cae519"
  },
  "status": {
    "id": "562c9774cc8d4b049e1ff8daf64f21ac"
  },
  "unit": {
    "id": "599330c7e61e41e59d3bf446daee8d92"
  },
  "worker": {
    "id": "3ecf777071f14e1c861073fe6b35690d"
  },
  "calendarDate": "2024-06-01T07:00:00.000Z",
  "timeEntryCode": {
    "id": "5c5a72e5658244629fbc518891ad5e29"
  },
  "projectRole": {
    "id": "848431263b594196bff57da192988322"
  },
  "overrideRate": "3",
  "projectPlanPhase": {
    "id": "99a0270269d94b4099996adf4a00462f"
  },
  "outReason": {
    "id": "25feff6c52bb43f098886904bd161d4f"
  },
  "project": {
    "id": "17a4a68190c644aa8d96b7a09d3b87dc"
  },
  "projectPlanTask": {
    "id": "88f01e603ed849c2b4a32591b4f9a9d3"
  },
  "currency": {
    "id": "e4930a3e1f744384979d18a80819e220"
  }
}
Instance Descriptor

Human-readable preview label for the referenced instance.

Logan McNeil
Instance ID

Identifies the Workday instance being referenced.

3aa5550b7fe348b98d7b5741afc65534
Worker ID

Unique identifier for the Workday worker record.

3aa5550b7fe348b98d7b5741afc65534
Worker Time Block ID

Identifies the worker's reported time block.

4e6a8c0e2a5b47d9f1b3d5f7a9c1e3b5
Example Payload for Update Worker Time Block⤓
Loading…

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. | key: postFilesByContainerId

InputNotesExample
Connection

The Workday connection to use.

File

The contents to write to a file. Binary data generated from a previous step.

ZXhhbXBsZQ==
File Container ID

Identifies the file container whose files will be retrieved.

3b5d7f9a1c2e44b6d8f0a2c4e6b8d0f2
Tenant

The Workday tenant name used in API paths.

acme
Example Payload for Upload Files by Container ID⤓
Loading…

Verify Connection​

Verifies the connection by requesting a new access token and, optionally, reading a report. | key: verifyConnection

InputNotesExample
Connection

The Workday connection to use.

Report URL

Optional report URL to read after authenticating, to confirm the account can access it. Leave blank to check authentication only. The whole report is read, so use a small one.

https://wd2-impl-services1.workday.com/ccx/service/customreport2/acme/ISU_Orgvue/People_Report
Example Payload for Verify Connection⤓
Loading…

Changelog​

2026-11-11​

Updated the component description to better summarize what the component does

2026-11-10​

Refactored internal code

2026-11-09​

Updated spectral to 10.39.1

2026-11-05​

Updated spectral to 10.39.0

2026-11-04​

Published the component as an npm package, so code-native integrations can install it and call its actions, triggers and data sources from code with TypeScript types

2026-10-26​

Added refresh token authentication, report and query actions, and polling triggers, and updated existing actions:

  • Added the Refresh Token connection for authenticating with an API Client for Integrations and a refresh token, without browser sign-in
  • Added the Get RaaS Report, Run WQL Query, and Verify Connection actions for reading custom reports, running Workday Query Language queries, and confirming that a connection can authenticate
  • Added the Changed RaaS Report Rows, Changed WQL Query Rows, and New Event Steps polling triggers, with opt-in batching that dispatches each record individually or in configured batches; enabling batching changes the shape a downstream step receives
  • Added an optional Look-back Date input across all polling triggers for performing an initial sync of records. The initial sync begins on the first recurrence and backfills every record from the specified date on, seeding each once; later recurrences are unaffected. Leave it empty to start from the first recurrence with no backfill
  • Added output schemas to 53 actions for improved field mapping during configuration
  • Added inline action calling support to 57 actions for improved example output during configuration
  • Added Fetch All and Pagination to List Organizations, List Message Templates, List Invoices, and Get Time Clock Events; Fetch All stays a top-level toggle
  • Updated Create Time Off Request, Create Supplier Invoice Request, and Update Time Clock Event by ID to group related inputs into the Business Process Parameters, Amounts, and Assignment IDs structured objects respectively
  • Updated Time Tracking endpoints from v5 to v7, which removes the Clock Event Date Time and Clock Event Time Zone ID inputs from Update Time Clock Event by ID
  • Updated Send Message to take its email and push notification content as individual Message Details fields (Email Detail Name, Email Detail Subject, Email Detail Body, Email Detail Reply To, Push Detail Message, Push Detail Redirect URL, and Push Detail ID) in place of the JSON Email Detail and Push Detail inputs, and Create Table and Update Table by ID to take Tags as a separate input with one row per tag in place of the JSON value in Additional Fields
  • Updated Create Message Template and Update Message Template by ID to take Email Detail (Name, Subject, Body, and Reply To) and Push Detail (Message, Redirect URL, and ID) as structured objects in place of JSON values, and Create Job Change to take Proposed Organizations as one row per organization with an ID and a Descriptor in place of a JSON array
  • Updated the Query Params input to Extra Parameters on 14 actions that accept query-string parameters, and the JSON Additional Fields input to Extra Body on Create Supplier Invoice Request, Create Message Template, Update Message Template by ID, Initiate Job Change, Initiate Organization Assignment Change, Create Worker Time Block, Update Time Clock Event by ID, and Update Worker Time Block
  • Updated Initiate Job Change and Initiate Organization Assignment Change to send the Worker ID as the worker in the request body, which removes the Change Job Worker ID and Change Org Worker ID inputs
  • Updated inputs to match the Workday API: Create Supplier Invoice Request now requires Company ID, Supplier ID, and Invoice Date, List Organizations requires Organization Type ID, List Data Changes requires Data Change Type or Data Change Name, Create Message Template and Update Message Template by ID require a new Notification Type ID, Update Message Template by ID requires Message Template Name, and Create Supplier Invoice Request Attachment uploads the content of a new required File input; also added an optional Organization Type ID to the Select Organization data source and to Get Organization by ID, where it filters the organization dropdown, optional Supervisory Organization ID and Location ID inputs to Initiate Job Change, and an optional Position ID input to Initiate Organization Assignment Change
  • Fixed List People ignoring Fetch All, Fetch All stopping early when Workday returned fewer records than the requested Limit, Get Invoice PDF returning a corrupted file, invalid JSON in code inputs being sent in the request instead of rejected, the Select Data Change data source failing to load, and Create Payment, Create Supplier Invoice Request Attachment, Create Table, Send Message, and Update Table by ID failing when their optional Additional Fields, Attachment Details, or Message Details input was left unset

Reconfiguration notice: Send Message no longer reads JSON values in the Email Detail and Push Detail inputs of Message Details, and Create Table and Update Table by ID no longer read a JSON Tags value in Additional Fields. Re-enter that email and push content in the new Message Details fields, and those tags as rows in Tags. Create Message Template and Update Message Template by ID no longer read JSON in Email Detail and Push Detail, and Create Job Change no longer reads a JSON Proposed Organizations array; re-enter that content in the individual fields and as ID and Descriptor rows, noting that an organization Href can no longer be sent. Values saved in Query Params on the 14 affected actions, in Additional Fields on the 8 affected actions, in Supplier Invoice ID on Create Supplier Invoice Request, and in Template Descriptor on Create Message Template and Update Message Template by ID are no longer read; re-enter them in Extra Parameters, Extra Body, Supplier Invoice ID, and Template Descriptor. Create Message Template and Update Message Template by ID now fail without a Notification Type ID, and Update Message Template by ID without a Message Template Name, so enter both. Update Time Clock Event by ID no longer sends Clock Event Date Time or Clock Event Time Zone ID, which Time Tracking v7 does not accept, so there is nothing to re-enter; check any step that relied on it to change a clock event's time or time zone. Initiate Job Change and Initiate Organization Assignment Change no longer read Change Job Worker ID or Change Org Worker ID and always send the Worker ID as the body worker, so there is nothing to re-enter; check any step that targeted a different worker in the body.

2026-07-16​

Restructured action inputs into structured objects for an improved user experience:

  • Grouped the Email Detail, Push Detail, and Contacts inputs of Send Message into a single Message Details structured object
  • Grouped the File Length, File Name, and Supplier Invoice Request Attachment Descriptor inputs of Create Supplier Invoice Request Attachment into a single Attachment Details structured object
  • Grouped the optional secondary inputs of Create Payment (Ready to Auto Apply, Reference, Transaction Number, Memo, Payment Descriptor) into a single Additional Fields structured object
  • Grouped the optional secondary inputs of Create Table and Update Table by ID (Description, Documentation, Enable For Analysis, Tags) into a single Additional Fields structured object
  • Grouped the Limit and Offset inputs into a single Pagination structured object across all 13 paginated list actions (Get Time Off Details, Get Supplier Invoice Request Attachments, List Supplier Invoice Requests, Get Event Attachments, List Events, Get Worker Business Title Changes, List People, List Data Changes, List Tables, Get Staffing Workers, Get Worker Explicit Skills, Get Worker Service Dates, List Workers). The Fetch All toggle remains a top-level input

2026-06-11​

Added Fetch All toggle to all paginated list actions (List People, List Supplier Invoice Requests, Get Supplier Invoice Request Attachments, List Events, Get Event Attachments, Get Worker Business Title Changes, List Data Changes, List Tables, Get Workers, Get Staffing Workers, Get Worker Explicit Skills, Get Worker Service Dates, Get Time Off Details) that automatically paginates through all results using limit/offset; when disabled, existing single-page behavior is preserved

2026-04-30​

Updated spectral version

2026-04-22​

Added Staffing (v7) service integration with six new actions:

  • Get Staffing Workers - Retrieve a list of workers
  • Get Staffing Worker By ID - Retrieve a specific worker by ID
  • Get Worker Service Dates - Retrieve service dates for a worker
  • Get Worker Explicit Skills - Retrieve explicit skills for a worker
  • Initiate Job Change - Start a job change business process for a worker
  • Initiate Organization Assignment Change - Start an organization assignment change for a worker

Upgraded Time Tracking endpoints from v3 to v5, Absence Management endpoints from v1 to v5, and Person endpoints from v3 to v4

2026-03-16​

Improved input field documentation with formatted URL links for better readability

2026-02-26​

Added inline data source for workers to enable dynamic dropdown selection