Skip to navigation

Connector Systems S–Z

View as Markdown

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.

FieldTypeRequiredNotes
standard_urlStandardSimpplrOneUrlThe base URL of your Simpplr instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.
custom_urlCustomBaseUrlA 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_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials grant using the client ID and secret of an app registered in Simpplr. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to Simpplr. Set exactly one authentication method.

Example create body:

{
"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.

FieldTypeRequiredNotes
regionstringYour Slack environment: COMMERCIAL (slack.com) or GOV (slack-gov.com). Defaults to COMMERCIAL if not set.
workspace_idstringThe team ID of the Slack workspace you are connecting, starting with ‘T’ (for example T12345678). Required. Checked when saved.
workspace_bot_tokenstringThe Bot User OAuth token for the Slack workspace, starting with ‘xoxb-’. Required. Checked when saved. Secret: always returned masked as *****.
user_consent_authSlackUserConsentAuthOptional Slack app credentials used for user-consent OAuth authorization.

Example create body:

{
"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.

FieldTypeRequiredNotes
regionstringYour Slack environment, used to build the base URL. Allowed values: COMMERCIAL, GOV. Defaults to COMMERCIAL if not set.
workspacesarray<SlackWorkspaceCredential>The Slack workspaces to connect, each with its team ID and bot token.

Example create body:

{
"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.

FieldTypeRequiredNotes
api_key_authApiKeyAuthAPI key authentication using a key generated in Slite. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication 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:

{
"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.

FieldTypeRequiredNotes
standard_urlStandardSolarwindsUrlThe base URL of your SolarWinds instance, given as scheme, subdomain, and domain.
api_key_authApiKeyAuthAPI key authentication using a key generated in SolarWinds. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication 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:

{
"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.

FieldTypeRequiredNotes
standard_urlStandardSquizUrlThe base URL of your Squiz instance, given as scheme, subdomain, and domain.
api_key_authApiKeyAuthAPI key authentication using a key generated in Squiz. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication 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:

{
"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.

FieldTypeRequiredNotes
standard_urlStandardStaffbaseUrlThe base URL of your Staffbase instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.
custom_urlCustomBaseUrlA 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_authApiKeyAuthAPI key authentication using a key generated in Staffbase. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to Staffbase. Set exactly one authentication method.

Example create body:

{
"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.

FieldTypeRequiredNotes
standard_urlSymphonyStandardUrlThe base URL of your Symphony instance, given as scheme, subdomain, and domain.
basic_authBasicAuthenticationBasic authentication with the username and password of a Symphony service account. Set exactly one authentication method.
api_key_authApiKeyAuthAPI key authentication using a key generated in Symphony. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication 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:

{
"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.

FieldTypeRequiredNotes
base_urlSysaidStandardUrlThe base URL of your SysAid instance, given as scheme, subdomain, and domain.
cookie_authBasicAuthenticationSession cookie authentication obtained by logging in with the username and password of a SysAid account. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication 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:

{
"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.

FieldTypeRequiredNotes
standard_urlStandardUnilyUrlThe base URL of your Unily instance, given as scheme, subdomain, and domain.
oauth2_client_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials grant using the client ID and secret of an app registered in Unily. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication 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:

{
"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.

FieldTypeRequiredNotes
standard_urlStandardUnilyLegacyUrlThe base URL of your Unily instance, given as scheme, subdomain, and domain.
oauth2_client_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials grant using the client ID and secret of an app registered in Unily. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication 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:

{
"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.

FieldTypeRequiredNotes
standard_urlStandardWikijsUrlThe base URL of your Wiki.js instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.
custom_urlCustomBaseUrlA 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_authApiKeyAuthAPI key authentication using a key generated in Wiki.js. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to Wiki.js. Set exactly one authentication method.

Example create body:

{
"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.

FieldTypeRequiredNotes
standard_urlStandardWolkenUrlThe base URL of your Wolken instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.
custom_urlCustomBaseUrlA 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_accountstringThe email address of the Wolken service account the connector acts as.
wolken_oauth2WolkenOAuth2OAuth 2.0 refresh token grant for the Wolken API. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to Wolken. Set exactly one authentication method.

Example create body:

{
"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.

FieldTypeRequiredNotes
standard_urlStandardWordpressUrlThe base URL of your WordPress instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.
custom_urlCustomBaseUrlA 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_authBasicAuthenticationBasic authentication with the username and password of a WordPress service account. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to WordPress. Set exactly one authentication method.

Example create body:

{
"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.

FieldTypeRequiredNotes
tenant_idstringThe name of your Workday tenant.
custom_urlCustomBaseUrlThe base URL of your Workday API host, given as a scheme and path. Required. Checked when saved.
oauth2_refreshOAuth2RefreshTokenOAuth 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_authOnPremiseAuthAuthentication 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:

{
"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.

FieldTypeRequiredNotes
standard_urlStandardWorkZoneUrlThe base URL of your SAP Work Zone instance, given as scheme, subdomain, and domain.
api_key_authApiKeyAuthAPI key authentication using a key generated in SAP Work Zone. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication 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:

{
"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.

FieldTypeRequiredNotes
standard_urlStandardZendeskUrlThe base URL of your Zendesk instance, given as scheme, subdomain, and domain. Set either standard_url or custom_url.
custom_urlCustomBaseUrlA 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_authBasicAuthenticationBasic authentication with the username and password of a Zendesk service account. Set exactly one authentication method.
oauth2_authZendeskOAuth2AuthOAuth 2.0 authentication through the Moveworks Zendesk app, using a refresh token. Set exactly one authentication method.

Example create body:

{
"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.

FieldTypeRequiredNotes
standard_urlStandardZendeskLegacyUrlThe base URL of your Zendesk instance, given as scheme, subdomain, and domain. The subdomain is required.
webhook_deployedbooleanIf true, Zendesk webhooks are enabled. Set to true when using Zendesk webhooks for ticket syncing in Channel Resolver.
fetch_comment_for_webhookbooleanIf 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_authBasicAuthenticationBasic authentication with the username and password of a Zendesk service account. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication through an on-premise agent that relays requests to Zendesk. Set exactly one authentication method.
oauth2_refreshZendeskOAuth2RefreshTokenAuthOAuth 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:

{
"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.

FieldTypeRequiredNotes
oauth2_client_credentials_grantZoomOAuth2ClientCredentialsGrantOAuth 2.0 client credentials grant using a Zoom Server-to-Server OAuth app. Set exactly one authentication method.
on_prem_authOnPremiseAuthAuthentication 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:

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