Skip to navigation

Connector Systems D–M

View as Markdown

Per-system connector reference (DROPBOX → MANAGE_ENGINE). 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_DROPBOX

Config block: dropbox_config

Dropbox connection settings, used when system is EXTERNAL_SYSTEM_DROPBOX. Set exactly one system-specific config.

FieldTypeRequiredNotes
select_user_idstringTeam member ID of the service account. Dropbox requires it to identify the user accessing content.
path_root_idstringID of the root folder where content ingestion starts.
oauth2_refreshOAuth2RefreshTokenOAuth 2.0 refresh token grant using the client ID, client secret, and refresh token of your Dropbox app. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of oauth2_refresh, on_prem_auth.

Example create body:

{
"name": "dropbox_connector",
"system": "EXTERNAL_SYSTEM_DROPBOX",
"dropbox_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_DUO

Config block: duo_config

Duo connection settings, used when system is EXTERNAL_SYSTEM_DUO. Set exactly one system-specific config.

FieldTypeRequiredNotes
base_urlDuoStandardUrlDuo Admin API hostname, built from scheme, subdomain, and domain.
integration_keystringIntegration key of your Duo Admin API application. Secret: always returned masked as *****.
secret_keystringSecret key of your Duo Admin API application. Secret: always returned masked as *****.

Example create body:

{
"name": "duo_connector",
"system": "EXTERNAL_SYSTEM_DUO",
"duo_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_EIGHT_X_EIGHT

Config block: eight_x_eight_config

8x8 connection settings, used when system is EXTERNAL_SYSTEM_EIGHT_X_EIGHT. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardEightXEightUrlBase URL of the 8x8 API, built from scheme, subdomain, and domain.
api_key_authApiKeyAuthAPI key authentication for 8x8. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of api_key_auth, on_prem_auth.

Example create body:

{
"name": "eight_x_eight_connector",
"system": "EXTERNAL_SYSTEM_EIGHT_X_EIGHT",
"eight_x_eight_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_EXCHANGE

Config block: exchange_config

Microsoft Exchange Online connection settings, used when system is EXTERNAL_SYSTEM_EXCHANGE. Set exactly one system-specific config.

FieldTypeRequiredNotes
app_idstringApplication (client) ID of the Microsoft Entra app registration used to connect to Exchange Online.
tenant_domainExchangeTenantDomainYour Microsoft 365 tenant domain, built from scheme, subdomain, and domain (for example, https://company.onmicrosoft.com).
modern_pki_authExchangeModernPKIAuthCertificate-based authentication using the certificate registered on your Microsoft Entra app.

Set at most one of modern_pki_auth.

Example create body:

{
"name": "exchange_connector",
"system": "EXTERNAL_SYSTEM_EXCHANGE",
"exchange_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_FIELDGLASS

Config block: fieldglass_config

SAP Fieldglass connection settings, used when system is EXTERNAL_SYSTEM_FIELDGLASS. Set exactly one system-specific config.

FieldTypeRequiredNotes
custom_base_urlCustomBaseUrlBase URL of your SAP Fieldglass instance.
system_timezonestringTime zone of your Fieldglass system as a time zone name (for example, America/Los_Angeles). Only letters, underscores, and slashes are allowed.
oauth2_client_credentialsFieldglassOAuth2ClientCredentialsAuthentication with a Fieldglass username, password, and client-specific application key. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of oauth2_client_credentials, on_prem_auth.

Example create body:

{
"name": "fieldglass_connector",
"system": "EXTERNAL_SYSTEM_FIELDGLASS",
"fieldglass_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_FIVE_NINE

Config block: five_nine_config

Five9 connection settings, used when system is EXTERNAL_SYSTEM_FIVE_NINE. Set exactly one system-specific config.

FieldTypeRequiredNotes
service_now_urlStandardSnowUrlBase URL of the ServiceNow instance where live agent conversation tickets are created.
service_now_agent_id_urlstringServiceNow endpoint used to look up the agent ID on the instance where live agent conversation tickets are created.
service_now_work_note_transcript_attachment_urlstringServiceNow endpoint used to attach the live agent conversation transcript to the ticket as a work note.
basic_authBasicAuthenticationUsername and password of the ServiceNow account used to attach transcripts. Required. Checked when saved.

Example create body:

{
"name": "five_nine_connector",
"system": "EXTERNAL_SYSTEM_FIVE_NINE",
"five_nine_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_FRESH_CHAT

Config block: fresh_chat_config

Freshchat connection settings, used when system is EXTERNAL_SYSTEM_FRESH_CHAT. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardFreshChatUrlStandard Freshchat base URL, built from scheme, subdomain, and domain. Set either this or custom_url.
custom_urlCustomBaseUrlCustom base URL of your Freshchat instance. Use when your instance is not on the standard domain. Set either this or standard_url.
api_key_authApiKeyAuthAPI key authentication for Freshchat. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.
user_polling_start_datestringDate from which user ingestion starts, in ISO 8601 format (for example, 2023-10-01T00:00:00Z). If not set, defaults to 30 days before the current date.

Example create body:

{
"name": "fresh_chat_connector",
"system": "EXTERNAL_SYSTEM_FRESH_CHAT",
"fresh_chat_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_FRESH_DESK

Config block: fresh_desk_config

Freshdesk connection settings, used when system is EXTERNAL_SYSTEM_FRESH_DESK. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardFreshDeskUrlBase URL of your Freshdesk instance, built from scheme, subdomain, and domain.
api_key_authApiKeyAuthAPI key authentication for Freshdesk. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of api_key_auth, on_prem_auth.

Example create body:

{
"name": "fresh_desk_connector",
"system": "EXTERNAL_SYSTEM_FRESH_DESK",
"fresh_desk_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_FRESH_SERVICE

Config block: fresh_service_config

Freshservice connection settings, used when system is EXTERNAL_SYSTEM_FRESH_SERVICE. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardFreshServiceUrlBase URL of your Freshservice instance, built from scheme, subdomain, and domain.
api_key_authApiKeyAuthAPI key authentication for Freshservice. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of api_key_auth, on_prem_auth.

Example create body:

{
"name": "fresh_service_connector",
"system": "EXTERNAL_SYSTEM_FRESH_SERVICE",
"fresh_service_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_GDRIVE

Config block: gdrive_config

Google Drive connection settings, used when system is EXTERNAL_SYSTEM_GDRIVE. Set exactly one system-specific config.

FieldTypeRequiredNotes
service_account_authGDriveServiceAccountAuthGoogle service account authentication without domain-wide delegation. Set exactly one auth method.
oauth2_refreshOAuth2RefreshTokenOAuth 2.0 refresh token grant using the client ID, client secret, and refresh token from your Google Drive app’s credentials. Set exactly one auth method.

Set at most one of service_account_auth, oauth2_refresh.

Example create body:

{
"name": "gdrive_connector",
"system": "EXTERNAL_SYSTEM_GDRIVE",
"gdrive_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_GDRIVE_LEGACY

Config block: gdrive_legacy_config

Google Drive (legacy) connection settings, used when system is EXTERNAL_SYSTEM_GDRIVE_LEGACY. Set exactly one system-specific config.

FieldTypeRequiredNotes
oauth2_refreshOAuth2RefreshTokenOAuth 2.0 refresh token grant using the client ID, client secret, and refresh token from your Google app’s credentials. Set exactly one auth method.
service_account_authGdriveServiceAccountAuthGoogle service account authentication. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of oauth2_refresh, service_account_auth, on_prem_auth.

Example create body:

{
"name": "gdrive_legacy_connector",
"system": "EXTERNAL_SYSTEM_GDRIVE_LEGACY",
"gdrive_legacy_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_GENESYS

Config block: genesys_config

Genesys connection settings, used when system is EXTERNAL_SYSTEM_GENESYS. Set exactly one system-specific config.

FieldTypeRequiredNotes
customer_regionstringDomain of your Genesys Cloud region, such as ‘mypurecloud.com’, ‘mypurecloud.ie’, ‘mypurecloud.de’, or ‘usw2.pure.cloud’. Required. Checked when saved.
oauth2_client_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials using the client ID and client secret of your Genesys Cloud OAuth client.

Example create body:

{
"name": "genesys_connector",
"system": "EXTERNAL_SYSTEM_GENESYS",
"genesys_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_GITHUB

Config block: github_config

GitHub connection settings, used when system is EXTERNAL_SYSTEM_GITHUB. Set exactly one system-specific config.

FieldTypeRequiredNotes
installation_idstringInstallation ID of the Moveworks GitHub App in your organization, used to request installation access tokens. At least 8 characters.

Example create body:

{
"name": "github_connector",
"system": "EXTERNAL_SYSTEM_GITHUB",
"github_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_GLIA

Config block: glia_config

Glia connection settings, used when system is EXTERNAL_SYSTEM_GLIA. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardGliaUrlStandard Glia base URL, built from scheme, subdomain, and domain. Set either this or custom_url.
custom_urlCustomBaseUrlCustom base URL of your Glia instance. Use when your instance is not on the standard domain. Set either this or standard_url.
oauth2_client_credentialsOAuth2ClientCredentialsGlia API key authentication using an API key ID and API key secret. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.
service_credentialsOAuth2ClientCredentialsGlia service credentials using an API key ID and API key secret. Set exactly one auth method.

Example create body:

{
"name": "glia_connector",
"system": "EXTERNAL_SYSTEM_GLIA",
"glia_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_GSUITE

Config block: gsuite_config

Google Workspace (G Suite) connection settings, used when system is EXTERNAL_SYSTEM_GSUITE. Set exactly one system-specific config.

FieldTypeRequiredNotes
credentialsstringGoogle credentials JSON file used to connect to Google Workspace. Secret: always returned masked as *****.
customer_idstringYour Google Workspace customer ID.
service_account_credentialsGsuiteServiceAccountCredentialsGoogle service account credentials, optionally with domain-wide delegation. Set either this or oauth_credentials.
oauth_credentialsGsuiteOAuthCredentialsOAuth 2.0 credentials from your Google Cloud app. Set either this or service_account_credentials.

Set at most one of service_account_credentials, oauth_credentials.

Example create body:

{
"name": "gsuite_connector",
"system": "EXTERNAL_SYSTEM_GSUITE",
"gsuite_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_GURU

Config block: guru_config

Guru connection settings, used when system is EXTERNAL_SYSTEM_GURU. Set exactly one system-specific config.

FieldTypeRequiredNotes
basic_authBasicAuthenticationBasic authentication with the username and password of a Guru account. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of basic_auth, on_prem_auth.

Example create body:

{
"name": "guru_connector",
"system": "EXTERNAL_SYSTEM_GURU",
"guru_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_IGLOO

Config block: igloo_config

Igloo connection settings, used when system is EXTERNAL_SYSTEM_IGLOO. Set exactly one system-specific config.

FieldTypeRequiredNotes
custom_base_urlCustomBaseUrlBase URL of your Igloo instance.
cookie_authIglooCookieAuthIgloo session (cookie) authentication with a user account and an app ID and password. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of cookie_auth, on_prem_auth.

Example create body:

{
"name": "igloo_connector",
"system": "EXTERNAL_SYSTEM_IGLOO",
"igloo_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_INTERACT

Config block: interact_config

Interact connection settings, used when system is EXTERNAL_SYSTEM_INTERACT. Set exactly one system-specific config.

FieldTypeRequiredNotes
custom_urlCustomBaseUrlBase URL of your Interact intranet.
tenant_idstringYour Interact tenant ID, sent with each request to identify your tenant.
oauth2_password_grantBasicAuthenticationOAuth 2.0 password grant using the username and password of an Interact account. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of oauth2_password_grant, on_prem_auth.

Example create body:

{
"name": "interact_connector",
"system": "EXTERNAL_SYSTEM_INTERACT",
"interact_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_IVANTI

Config block: ivanti_config

Ivanti connection settings, used when system is EXTERNAL_SYSTEM_IVANTI. Set exactly one system-specific config.

FieldTypeRequiredNotes
custom_base_urlCustomBaseUrlBase URL of your Ivanti instance.
api_key_authApiKeyAuthAPI key authentication for Ivanti. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of api_key_auth, on_prem_auth.

Example create body:

{
"name": "ivanti_connector",
"system": "EXTERNAL_SYSTEM_IVANTI",
"ivanti_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_JIRA

Config block: jira_config

Jira connection settings, used when system is EXTERNAL_SYSTEM_JIRA. Set exactly one system-specific config.

FieldTypeRequiredNotes
cloud_idstringYour Atlassian Cloud ID, which uniquely identifies your Jira instance.
user_consent_authJiraUserConsentAuthOAuth 2.0 user consent authentication using the client ID and client secret of your Atlassian app.

Set at most one of user_consent_auth.

Example create body:

{
"name": "jira_connector",
"system": "EXTERNAL_SYSTEM_JIRA",
"jira_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_JIRA_LEGACY

Config block: jira_legacy_config

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

FieldTypeRequiredNotes
standard_urlJiraStandardUrlStandard Jira Cloud base URL, built from scheme, subdomain, and domain. Set either this or custom_url.
custom_urlCustomBaseUrlCustom base URL of your Jira instance, for example a Jira Server URL. Set either this or standard_url.
cloud_basic_authBasicAuthenticationBasic authentication for Jira Cloud with a username and password (API token). Set exactly one auth method.
server_basic_authBasicAuthenticationBasic authentication for Jira Server with a username and password. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.
shared_secretstringSecret used to sign the JWT sent to the Jira Cloud identity app. Secret: always returned masked as *****.
gdpr_modebooleanIf true, ticket assignees are set by account ID instead of name. Recommended on for Jira Cloud and off for Jira Server and on-premise auth.
upload_attachments_as_activitybooleanIf true, attachments are added as ticket activity.
auth_headersarray<AuthHeader>Additional authentication headers sent with requests to Jira, as key and value pairs.

Example create body:

{
"name": "jira_legacy_connector",
"system": "EXTERNAL_SYSTEM_JIRA_LEGACY",
"jira_legacy_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_JIVE

Config block: jive_config

Jive connection settings, used when system is EXTERNAL_SYSTEM_JIVE. Set exactly one system-specific config.

FieldTypeRequiredNotes
custom_base_urlCustomBaseUrlBase URL of your Jive instance.
basic_authBasicAuthenticationBasic authentication with the username and password of a Jive account. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of basic_auth, on_prem_auth.

Example create body:

{
"name": "jive_connector",
"system": "EXTERNAL_SYSTEM_JIVE",
"jive_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_LUMAPPS

Config block: lumapps_config

LumApps connection settings, used when system is EXTERNAL_SYSTEM_LUMAPPS. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardLumappsUrlBase URL of the LumApps API, built from scheme, subdomain, and domain.
organization_idstringYour LumApps organization ID. Required. Checked when saved.
user_idstringID of the LumApps user on whose behalf application tokens are requested. Required. Checked when saved.
oauth2_client_credentialsOAuth2ClientCredentialsOAuth 2.0 client credentials grant using the client ID and client secret of your LumApps app. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Set at most one of oauth2_client_credentials, on_prem_auth.

Example create body:

{
"name": "lumapps_connector",
"system": "EXTERNAL_SYSTEM_LUMAPPS",
"lumapps_config": {},
"version": {
"change_description": "Initial version."
}
}

EXTERNAL_SYSTEM_MANAGE_ENGINE

Config block: manage_engine_config

ManageEngine ServiceDesk connection settings, used when system is EXTERNAL_SYSTEM_MANAGE_ENGINE. Set exactly one system-specific config.

FieldTypeRequiredNotes
standard_urlStandardManageEngineUrlStandard ManageEngine base URL, built from scheme, subdomain, and domain. Set either this or custom_url.
custom_urlCustomBaseUrlCustom base URL of your ManageEngine instance. Use when your instance is not on the standard domain. Set either this or standard_url.
oauth2_refreshOAuth2RefreshTokenOAuth 2.0 refresh token grant using the client ID, client secret, and refresh token of your ManageEngine app. Set exactly one auth method.
on_prem_authOnPremiseAuthOn-premise authentication through a Moveworks Agent running in your network. Set exactly one auth method.

Example create body:

{
"name": "manage_engine_connector",
"system": "EXTERNAL_SYSTEM_MANAGE_ENGINE",
"manage_engine_config": {},
"version": {
"change_description": "Initial version."
}
}