> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Connector Systems S–Z

> Fields and example bodies for each external system a Configuration API connector supports (S–Z).

Per-system connector reference (SIMPPLR_ONE → ZOOM). Every connector is created with `POST /platform/connectors` and the body `{"name": ..., "system": ..., "<system>_config": {...}, "version": {"change_description": ...}}`. Send the config block that matches `system`, and no other.

## EXTERNAL_SYSTEM_SIMPPLR_ONE

Config block: `simpplr_one_config`

Simpplr One connection settings, used when system is EXTERNAL_SYSTEM_SIMPPLR_ONE. Set exactly one system-specific config.

| Field                       | Type                    | Required | Notes                                                                                                                                                       |
| --------------------------- | ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url`              | StandardSimpplrOneUrl   |          | The base URL of your Simpplr instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.                                       |
| `custom_url`                | CustomBaseUrl           |          | A custom base URL for your Simpplr instance, given as a scheme and path. Use this instead of standard_url when the URL does not follow the standard format. |
| `oauth2_client_credentials` | OAuth2ClientCredentials |          | OAuth 2.0 client credentials grant using the client ID and secret of an app registered in Simpplr. Set exactly one authentication method.                   |
| `on_prem_auth`              | OnPremiseAuth           |          | Authentication through an on-premise agent that relays requests to Simpplr. Set exactly one authentication method.                                          |

Example create body:

```json
{
  "name": "simpplr_one_connector",
  "system": "EXTERNAL_SYSTEM_SIMPPLR_ONE",
  "simpplr_one_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_SLACK

Config block: `slack_config`

Slack connection settings, used when system is EXTERNAL_SYSTEM_SLACK. Set exactly one system-specific config.

| Field                 | Type                 | Required | Notes                                                                                                                                                |
| --------------------- | -------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `region`              | string               |          | Your Slack environment: COMMERCIAL (slack.com) or GOV (slack-gov.com). Defaults to COMMERCIAL if not set.                                            |
| `workspace_id`        | string               |          | The team ID of the Slack workspace you are connecting, starting with 'T' (for example T12345678). Required. Checked when saved.                      |
| `workspace_bot_token` | string               |          | The Bot User OAuth token for the Slack workspace, starting with 'xoxb-'. Required. Checked when saved. Secret: always returned masked as \*\*\*\*\*. |
| `user_consent_auth`   | SlackUserConsentAuth |          | Optional Slack app credentials used for user-consent OAuth authorization.                                                                            |

Example create body:

```json
{
  "name": "slack_connector",
  "system": "EXTERNAL_SYSTEM_SLACK",
  "slack_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_SLACK_LEGACY

Config block: `slack_legacy_config`

Slack (legacy) connection settings, used when system is EXTERNAL_SYSTEM_SLACK_LEGACY. Set exactly one system-specific config.

| Field        | Type                             | Required | Notes                                                                                                                   |
| ------------ | -------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------- |
| `region`     | string                           |          | Your Slack environment, used to build the base URL. Allowed values: COMMERCIAL, GOV. Defaults to COMMERCIAL if not set. |
| `workspaces` | array\<SlackWorkspaceCredential> |          | The Slack workspaces to connect, each with its team ID and bot token.                                                   |

Example create body:

```json
{
  "name": "slack_legacy_connector",
  "system": "EXTERNAL_SYSTEM_SLACK_LEGACY",
  "slack_legacy_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_SLITE

Config block: `slite_config`

Slite connection settings, used when system is EXTERNAL_SYSTEM_SLITE. Set exactly one system-specific config.

| Field          | Type          | Required | Notes                                                                                                            |
| -------------- | ------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
| `api_key_auth` | ApiKeyAuth    |          | API key authentication using a key generated in Slite. Set exactly one authentication method.                    |
| `on_prem_auth` | OnPremiseAuth |          | Authentication through an on-premise agent that relays requests to Slite. Set exactly one authentication method. |

Set at most one of `api_key_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "slite_connector",
  "system": "EXTERNAL_SYSTEM_SLITE",
  "slite_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_SOLARWINDS

Config block: `solarwinds_config`

SolarWinds connection settings, used when system is EXTERNAL_SYSTEM_SOLARWINDS. Set exactly one system-specific config.

| Field          | Type                  | Required | Notes                                                                                                                 |
| -------------- | --------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
| `standard_url` | StandardSolarwindsUrl |          | The base URL of your SolarWinds instance, given as scheme, subdomain, and domain.                                     |
| `api_key_auth` | ApiKeyAuth            |          | API key authentication using a key generated in SolarWinds. Set exactly one authentication method.                    |
| `on_prem_auth` | OnPremiseAuth         |          | Authentication through an on-premise agent that relays requests to SolarWinds. Set exactly one authentication method. |

Set at most one of `api_key_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "solarwinds_connector",
  "system": "EXTERNAL_SYSTEM_SOLARWINDS",
  "solarwinds_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_SQUIZ

Config block: `squiz_config`

Squiz connection settings, used when system is EXTERNAL_SYSTEM_SQUIZ. Set exactly one system-specific config.

| Field          | Type             | Required | Notes                                                                                                            |
| -------------- | ---------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
| `standard_url` | StandardSquizUrl |          | The base URL of your Squiz instance, given as scheme, subdomain, and domain.                                     |
| `api_key_auth` | ApiKeyAuth       |          | API key authentication using a key generated in Squiz. Set exactly one authentication method.                    |
| `on_prem_auth` | OnPremiseAuth    |          | Authentication through an on-premise agent that relays requests to Squiz. Set exactly one authentication method. |

Set at most one of `api_key_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "squiz_connector",
  "system": "EXTERNAL_SYSTEM_SQUIZ",
  "squiz_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_STAFFBASE

Config block: `staffbase_config`

Staffbase connection settings, used when system is EXTERNAL_SYSTEM_STAFFBASE. Set exactly one system-specific config.

| Field          | Type                 | Required | Notes                                                                                                                                                         |
| -------------- | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url` | StandardStaffbaseUrl |          | The base URL of your Staffbase instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.                                       |
| `custom_url`   | CustomBaseUrl        |          | A custom base URL for your Staffbase instance, given as a scheme and path. Use this instead of standard_url when the URL does not follow the standard format. |
| `api_key_auth` | ApiKeyAuth           |          | API key authentication using a key generated in Staffbase. Set exactly one authentication method.                                                             |
| `on_prem_auth` | OnPremiseAuth        |          | Authentication through an on-premise agent that relays requests to Staffbase. Set exactly one authentication method.                                          |

Example create body:

```json
{
  "name": "staffbase_connector",
  "system": "EXTERNAL_SYSTEM_STAFFBASE",
  "staffbase_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_SYMPHONY

Config block: `symphony_config`

Symphony connection settings, used when system is EXTERNAL_SYSTEM_SYMPHONY. Set exactly one system-specific config.

| Field          | Type                | Required | Notes                                                                                                                     |
| -------------- | ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
| `standard_url` | SymphonyStandardUrl |          | The base URL of your Symphony instance, given as scheme, subdomain, and domain.                                           |
| `basic_auth`   | BasicAuthentication |          | Basic authentication with the username and password of a Symphony service account. Set exactly one authentication method. |
| `api_key_auth` | ApiKeyAuth          |          | API key authentication using a key generated in Symphony. Set exactly one authentication method.                          |
| `on_prem_auth` | OnPremiseAuth       |          | Authentication through an on-premise agent that relays requests to Symphony. Set exactly one authentication method.       |

Set at most one of `basic_auth`, `api_key_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "symphony_connector",
  "system": "EXTERNAL_SYSTEM_SYMPHONY",
  "symphony_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_SYSAID

Config block: `sysaid_config`

SysAid connection settings, used when system is EXTERNAL_SYSTEM_SYSAID. Set exactly one system-specific config.

| Field          | Type                | Required | Notes                                                                                                                                           |
| -------------- | ------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `base_url`     | SysaidStandardUrl   |          | The base URL of your SysAid instance, given as scheme, subdomain, and domain.                                                                   |
| `cookie_auth`  | BasicAuthentication |          | Session cookie authentication obtained by logging in with the username and password of a SysAid account. Set exactly one authentication method. |
| `on_prem_auth` | OnPremiseAuth       |          | Authentication through an on-premise agent that relays requests to SysAid. Set exactly one authentication method.                               |

Set at most one of `cookie_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "sysaid_connector",
  "system": "EXTERNAL_SYSTEM_SYSAID",
  "sysaid_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_UNILY

Config block: `unily_config`

Unily connection settings, used when system is EXTERNAL_SYSTEM_UNILY. Set exactly one system-specific config.

| Field                       | Type                    | Required | Notes                                                                                                                                   |
| --------------------------- | ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url`              | StandardUnilyUrl        |          | The base URL of your Unily instance, given as scheme, subdomain, and domain.                                                            |
| `oauth2_client_credentials` | OAuth2ClientCredentials |          | OAuth 2.0 client credentials grant using the client ID and secret of an app registered in Unily. Set exactly one authentication method. |
| `on_prem_auth`              | OnPremiseAuth           |          | Authentication through an on-premise agent that relays requests to Unily. Set exactly one authentication method.                        |

Set at most one of `oauth2_client_credentials`, `on_prem_auth`.

Example create body:

```json
{
  "name": "unily_connector",
  "system": "EXTERNAL_SYSTEM_UNILY",
  "unily_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_UNILY_LEGACY

Config block: `unily_legacy_config`

Unily (legacy) connection settings, used when system is EXTERNAL_SYSTEM_UNILY_LEGACY. Set exactly one system-specific config.

| Field                       | Type                    | Required | Notes                                                                                                                                   |
| --------------------------- | ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url`              | StandardUnilyLegacyUrl  |          | The base URL of your Unily instance, given as scheme, subdomain, and domain.                                                            |
| `oauth2_client_credentials` | OAuth2ClientCredentials |          | OAuth 2.0 client credentials grant using the client ID and secret of an app registered in Unily. Set exactly one authentication method. |
| `on_prem_auth`              | OnPremiseAuth           |          | Authentication through an on-premise agent that relays requests to Unily. Set exactly one authentication method.                        |

Set at most one of `oauth2_client_credentials`, `on_prem_auth`.

Example create body:

```json
{
  "name": "unily_legacy_connector",
  "system": "EXTERNAL_SYSTEM_UNILY_LEGACY",
  "unily_legacy_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_WIKIJS

Config block: `wikijs_config`

Wiki.js connection settings, used when system is EXTERNAL_SYSTEM_WIKIJS. Set exactly one system-specific config.

| Field          | Type              | Required | Notes                                                                                                                                                       |
| -------------- | ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url` | StandardWikijsUrl |          | The base URL of your Wiki.js instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.                                       |
| `custom_url`   | CustomBaseUrl     |          | A custom base URL for your Wiki.js instance, given as a scheme and path. Use this instead of standard_url when the URL does not follow the standard format. |
| `api_key_auth` | ApiKeyAuth        |          | API key authentication using a key generated in Wiki.js. Set exactly one authentication method.                                                             |
| `on_prem_auth` | OnPremiseAuth     |          | Authentication through an on-premise agent that relays requests to Wiki.js. Set exactly one authentication method.                                          |

Example create body:

```json
{
  "name": "wikijs_connector",
  "system": "EXTERNAL_SYSTEM_WIKIJS",
  "wikijs_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_WOLKEN

Config block: `wolken_config`

Wolken connection settings, used when system is EXTERNAL_SYSTEM_WOLKEN. Set exactly one system-specific config.

| Field             | Type              | Required | Notes                                                                                                                                                      |
| ----------------- | ----------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url`    | StandardWolkenUrl |          | The base URL of your Wolken instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.                                       |
| `custom_url`      | CustomBaseUrl     |          | A custom base URL for your Wolken instance, given as a scheme and path. Use this instead of standard_url when the URL does not follow the standard format. |
| `service_account` | string            |          | The email address of the Wolken service account the connector acts as.                                                                                     |
| `wolken_oauth2`   | WolkenOAuth2      |          | OAuth 2.0 refresh token grant for the Wolken API. Set exactly one authentication method.                                                                   |
| `on_prem_auth`    | OnPremiseAuth     |          | Authentication through an on-premise agent that relays requests to Wolken. Set exactly one authentication method.                                          |

Example create body:

```json
{
  "name": "wolken_connector",
  "system": "EXTERNAL_SYSTEM_WOLKEN",
  "wolken_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_WORDPRESS

Config block: `wordpress_config`

WordPress connection settings, used when system is EXTERNAL_SYSTEM_WORDPRESS. Set exactly one system-specific config.

| Field          | Type                 | Required | Notes                                                                                                                                                         |
| -------------- | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url` | StandardWordpressUrl |          | The base URL of your WordPress instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.                                       |
| `custom_url`   | CustomBaseUrl        |          | A custom base URL for your WordPress instance, given as a scheme and path. Use this instead of standard_url when the URL does not follow the standard format. |
| `basic_auth`   | BasicAuthentication  |          | Basic authentication with the username and password of a WordPress service account. Set exactly one authentication method.                                    |
| `on_prem_auth` | OnPremiseAuth        |          | Authentication through an on-premise agent that relays requests to WordPress. Set exactly one authentication method.                                          |

Example create body:

```json
{
  "name": "wordpress_connector",
  "system": "EXTERNAL_SYSTEM_WORDPRESS",
  "wordpress_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_WORKDAY

Config block: `workday_config`

Workday connection settings, used when system is EXTERNAL_SYSTEM_WORKDAY. Set exactly one system-specific config.

| Field            | Type               | Required | Notes                                                                                                                                               |
| ---------------- | ------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tenant_id`      | string             |          | The name of your Workday tenant.                                                                                                                    |
| `custom_url`     | CustomBaseUrl      |          | The base URL of your Workday API host, given as a scheme and path. Required. Checked when saved.                                                    |
| `oauth2_refresh` | OAuth2RefreshToken |          | OAuth 2.0 refresh token grant using the client ID, client secret, and refresh token of a Workday API client. Set exactly one authentication method. |
| `on_prem_auth`   | OnPremiseAuth      |          | Authentication through an on-premise agent that relays requests to Workday. Set exactly one authentication method.                                  |

Set at most one of `oauth2_refresh`, `on_prem_auth`.

Example create body:

```json
{
  "name": "workday_connector",
  "system": "EXTERNAL_SYSTEM_WORKDAY",
  "workday_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_WORK_ZONE

Config block: `work_zone_config`

SAP Work Zone connection settings, used when system is EXTERNAL_SYSTEM_WORK_ZONE. Set exactly one system-specific config.

| Field          | Type                | Required | Notes                                                                                                                    |
| -------------- | ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `standard_url` | StandardWorkZoneUrl |          | The base URL of your SAP Work Zone instance, given as scheme, subdomain, and domain.                                     |
| `api_key_auth` | ApiKeyAuth          |          | API key authentication using a key generated in SAP Work Zone. Set exactly one authentication method.                    |
| `on_prem_auth` | OnPremiseAuth       |          | Authentication through an on-premise agent that relays requests to SAP Work Zone. Set exactly one authentication method. |

Set at most one of `api_key_auth`, `on_prem_auth`.

Example create body:

```json
{
  "name": "work_zone_connector",
  "system": "EXTERNAL_SYSTEM_WORK_ZONE",
  "work_zone_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_ZENDESK

Config block: `zendesk_config`

Zendesk connection settings, used when system is EXTERNAL_SYSTEM_ZENDESK. Set exactly one system-specific config.

| Field          | Type                | Required | Notes                                                                                                                                                       |
| -------------- | ------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `standard_url` | StandardZendeskUrl  |          | The base URL of your Zendesk instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.                                       |
| `custom_url`   | CustomBaseUrl       |          | A custom base URL for your Zendesk instance, given as a scheme and path. Use this instead of standard_url when the URL does not follow the standard format. |
| `basic_auth`   | BasicAuthentication |          | Basic authentication with the username and password of a Zendesk service account. Set exactly one authentication method.                                    |
| `oauth2_auth`  | ZendeskOAuth2Auth   |          | OAuth 2.0 authentication through the Moveworks Zendesk app, using a refresh token. Set exactly one authentication method.                                   |

Example create body:

```json
{
  "name": "zendesk_connector",
  "system": "EXTERNAL_SYSTEM_ZENDESK",
  "zendesk_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_ZENDESK_LEGACY

Config block: `zendesk_legacy_config`

Zendesk (legacy) connection settings, used when system is EXTERNAL_SYSTEM_ZENDESK_LEGACY. Set exactly one system-specific config.

| Field                       | Type                          | Required | Notes                                                                                                                                            |
| --------------------------- | ----------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `standard_url`              | StandardZendeskLegacyUrl      |          | The base URL of your Zendesk instance, given as scheme, subdomain, and domain. The subdomain is required.                                        |
| `webhook_deployed`          | boolean                       |          | If true, Zendesk webhooks are enabled. Set to true when using Zendesk webhooks for ticket syncing in Channel Resolver.                           |
| `fetch_comment_for_webhook` | boolean                       |          | If true, the full HTML body of ticket comments is fetched so hyperlinks are preserved in synced comments. Adds latency due to an extra API call. |
| `basic_auth`                | BasicAuthentication           |          | Basic authentication with the username and password of a Zendesk service account. Set exactly one authentication method.                         |
| `on_prem_auth`              | OnPremiseAuth                 |          | Authentication through an on-premise agent that relays requests to Zendesk. Set exactly one authentication method.                               |
| `oauth2_refresh`            | ZendeskOAuth2RefreshTokenAuth |          | OAuth 2.0 authentication using a Zendesk refresh token. Set exactly one authentication method.                                                   |

Set at most one of `basic_auth`, `on_prem_auth`, `oauth2_refresh`.

Example create body:

```json
{
  "name": "zendesk_legacy_connector",
  "system": "EXTERNAL_SYSTEM_ZENDESK_LEGACY",
  "zendesk_legacy_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```

## EXTERNAL_SYSTEM_ZOOM

Config block: `zoom_config`

Zoom connection settings, used when system is EXTERNAL_SYSTEM_ZOOM. Set exactly one system-specific config.

| Field                             | Type                             | Required | Notes                                                                                                              |
| --------------------------------- | -------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
| `oauth2_client_credentials_grant` | ZoomOAuth2ClientCredentialsGrant |          | OAuth 2.0 client credentials grant using a Zoom Server-to-Server OAuth app. Set exactly one authentication method. |
| `on_prem_auth`                    | OnPremiseAuth                    |          | Authentication through an on-premise agent that relays requests to Zoom. Set exactly one authentication method.    |

Set at most one of `oauth2_client_credentials_grant`, `on_prem_auth`.

Example create body:

```json
{
  "name": "zoom_connector",
  "system": "EXTERNAL_SYSTEM_ZOOM",
  "zoom_config": {},
  "version": {
    "change_description": "Initial version."
  }
}
```