workday-soap

What this skill does

# Workday SOAP

Workday SOAP is a cloud-based human capital management (HCM) system. It's used by large organizations to manage HR, payroll, talent management, and financial processes. Think of it as an enterprise-level HR and finance platform.

Official docs: https://community.workday.com/node/25998

## Workday SOAP Overview

- **Workers**
  - **Skills**
- **Organizations**
- **Compensation**
- **Job Postings**
- **Business Processes**
- **Reporting**
- **Security**
- **Tenants**
- **Audit Logs**
- **Integrations**
- **System Information**
- **User Accounts**
- **Roles**
- **Contingent Workers**
- **Applicants**
- **Benefits**
- **Absence Records**
- **Time Tracking**
- **Payroll**
- **Expenses**
- **Projects**
- **Assets**
- **Learning**
- **Goals**
- **Performance Reviews**
- **Succession Plans**
- **Talent Pools**
- **Surveys**
- **Cases**
- **Help Desk Tickets**
- **Knowledge Base Articles**
- **Vendors**
- **Customers**
- **Contracts**
- **Invoices**
- **Payments**
- **Financial Accounting**
- **Budgeting**
- **Grants**
- **Investments**
- **Supply Chain**
- **Inventory**
- **Manufacturing**
- **Quality Control**
- **Maintenance**
- **Facilities**
- **Real Estate**
- **Environment, Health, and Safety (EHS)**
- **Risk Management**
- **Compliance**
- **Legal**
- **Privacy**
- **Data Management**
- **Change Management**
- **Localization**
- **Mobile**
- **Accessibility**
- **Notifications**
- **Search**
- **Attachments**
- **Comments**
- **Tasks**
- **Events**
- **Dashboards**
- **Reports**
- **Formulas**
- **Calculations**
- **Data Validations**
- **Workday Extend**
- **Workday Studio**
- **Workday Web Services (SOAP)**
- **Workday REST API**
- **Workday Prism Analytics**
- **Workday Machine Learning**

Use action names and parameters as needed.

## Working with Workday SOAP

This skill uses the Membrane CLI to interact with Workday SOAP. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.

### Install the CLI

Install the Membrane CLI so you can run `membrane` from the terminal:

```bash
npm install -g @membranehq/cli@latest
```

### Authentication

```bash
membrane login --tenant --clientName=<agentType>
```

This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.

**Headless environments:** The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:

```bash
membrane login complete <code>
```

Add `--json` to any command for machine-readable JSON output.

**Agent Types** : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness

### Connecting to Workday SOAP

Use `membrane connection ensure` to find or create a connection by app URL or domain:

```bash
membrane connection ensure "https://www.workday.com" --json
```
The user completes authentication in the browser. The output contains the new connection id.

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has `state: "READY"`, skip to **Step 2**.

#### 1b. Wait for the connection to be ready

If the connection is in `BUILDING` state, poll until it's ready:

```bash
npx @membranehq/cli connection get <id> --wait --json
```

The `--wait` flag long-polls (up to `--timeout` seconds, default 30) until the state changes. Keep polling until `state` is no longer `BUILDING`.

The resulting state tells you what to do next:

- **`READY`** — connection is fully set up. Skip to **Step 2**.
- **`CLIENT_ACTION_REQUIRED`** — the user or agent needs to do something. The `clientAction` object describes the required action:
  - `clientAction.type` — the kind of action needed:
    - `"connect"` — user needs to authenticate (OAuth, API key, etc.). This covers initial authentication and re-authentication for disconnected connections.
    - `"provide-input"` — more information is needed (e.g. which app to connect to).
  - `clientAction.description` — human-readable explanation of what's needed.
  - `clientAction.uiUrl` (optional) — URL to a pre-built UI where the user can complete the action. Show this to the user when present.
  - `clientAction.agentInstructions` (optional) — instructions for the AI agent on how to proceed programmatically.

  After the user completes the action (e.g. authenticates in the browser), poll again with `membrane connection get <id> --json` to check if the state moved to `READY`.

- **`CONFIGURATION_ERROR`** or **`SETUP_FAILED`** — something went wrong. Check the `error` field for details.

### Searching for actions

Search using a natural language description of what you want to do:

```bash
membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json
```

You should always search for actions in the context of a specific connection.

Each result includes `id`, `name`, `description`, `inputSchema` (what parameters the action accepts), and `outputSchema` (what it returns).

## Popular actions

| Name | Key | Description |
| --- | --- | --- |
| Get Compensation Plans | get-compensation-plans | Retrieves compensation plan data from Workday including salary plans, bonus plans, and merit plans. |
| Get Worker Time Off Balances | get-worker-time-off-balances | Retrieves time off balance information for a specific worker from Workday Absence Management. |
| Get Supervisory Organizations | get-supervisory-organizations | Retrieves supervisory organization data from Workday including org hierarchy, managers, and staffing information. |
| Get Time Off Plans | get-time-off-plans | Retrieves time off plan data from Workday Absence Management including plan configurations and eligibility rules. |
| Get Cost Centers | get-cost-centers | Retrieves cost center data from Workday including cost center hierarchy and related organizations. |
| Get Positions | get-positions | Retrieves position data from Workday Staffing service including position details, assignments, and restrictions. |
| Get Job Profiles | get-job-profiles | Retrieves job profile data from Workday including job titles, job families, and compensation grades. |
| Get Locations | get-locations | Retrieves location data from Workday including business sites, work spaces, and address information. |
| Get Organizations | get-organizations | Retrieves organization data from Workday including supervisory organizations, cost centers, companies, and custom org... |
| Get Workers | get-workers | Retrieves worker data from Workday including personal information, employment details, and compensation data. |

### Running actions

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --json
```

To pass JSON parameters:

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json
```

The result is in the `output` field of the response.


### Proxy requests

When the available actions don't cover your use case, you can send requests directly to the Workday SOAP API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transparent credential refresh if they expire.

```bash
membrane request CONNECTION_ID /path/to/endpoint
```

Common options:

| Flag | Description |
|------|-------------|
| `-X, --method` | HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET |
| `-H, --header` | Add a request header (repeatable), e.g. `-H "Accept: application/json"` |
| `-d, --data` | Request body (string) |
| `--json` | Shorthand to send a JSON body and set `Content-Type: application/json` |
| `--rawData` | Send the body as-is without any processing |
| `--query` | Query-string parameter (repeatable),