Skip to navigation

Connectors

View as Markdown

Connectors hold the credentials and endpoint for one external system; everything else (ticketing, content, forms, access skills, live agent) references a connector by its id (returned on create).

  • Endpoint: /platform/connectors | Methods: GET, PATCH, POST
  • Request shape: fields go at the top level of the JSON body, with no resource wrapper. The item’s id goes in the URL for reads and updates, not in the body.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/platform/connectorsList connectors
POST/platform/connectorsCreate connector
GET/platform/connectors/{id}Get connector
PATCH/platform/connectors/{id}Update connector

Every system is documented with its fields, required inputs, pick-one choice groups, and an example body in the Connector Systems sub-pages (A–D, D–M, M–S, S–Z).

Choice groups are common: e.g. ServiceNow needs exactly one base-URL block (standard_url | custom_url) and exactly one auth block (basic_auth | oauth2_password | …).

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique identifier of the connector, assigned by the server. Include it in update requests to identify the connector.
namestringUnique name of the connector, used by other configurations to reference it. Cannot be changed after creation, and a name cannot be reused.
systemenumExternal system this connector connects to. Determines which system-specific config must be set. Cannot be changed after creation. One of: EXTERNAL_SYSTEM_BOX, EXTERNAL_SYSTEM_BOX_LEGACY, EXTERNAL_SYSTEM_SERVICE_NOW, EXTERNAL_SYSTEM_CONFLUENCE, EXTERNAL_SYSTEM_GDRIVE, EXTERNAL_SYSTEM_JIRA, EXTERNAL_SYSTEM_OUTLOOK, EXTERNAL_SYSTEM_SHAREPOINT_ONEDRIVE, … (91 values).
updated_atstringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersion✅Document version. On update, send back the num from your last read.

Set at most one of box_legacy_config, service_now_config, box_config, confluence_config, gdrive_config, jira_config, outlook_config, sharepoint_onedrive_config, slack_config, unily_config, zendesk_config, ariba_config, amazon_connect_config, authhub_config, axero_config, backstage_config, beyond_trust_config, bmc_remedy_config, bmc_remedy_dwp_config, bmc_remedyforce_config, brainstorm_config, brightspot_config, cherwell_config, comaround_config, concur_config, confluence_legacy_config, confluence_server_config, connect_wise_config, contentful_config, coupa_config, dovetail_config, dropbox_config, duo_config, eight_x_eight_config, exchange_config, fieldglass_config, five_nine_config, fresh_chat_config, fresh_desk_config, fresh_service_config, gdrive_legacy_config, genesys_config, github_config, glia_config, gsuite_config, guru_config, igloo_config, interact_config, ivanti_config, jira_legacy_config, jive_config, lumapps_config, manage_engine_config, meta_workplace_config, microsoft_dynamics_config, ms_graph_config, ms_teams_org_config, notion_config, officespace_config, okta_config, onelogin_config, oracle_config, ping_config, promapp_config, quip_config, right_answers_config, sailpoint_config, sailpoint_inow_config, salesforce_config, screen_steps_config, searchunify_config, sharepoint_msgraph_config, sharepoint_online_config, simpplr_config, simpplr_one_config, slack_legacy_config, slite_config, solarwinds_config, squiz_config, staffbase_config, symphony_config, sysaid_config, unily_legacy_config, wikijs_config, wolken_config, wordpress_config, work_zone_config, workday_config, zendesk_legacy_config, zoom_config, content_gateway_system_config.

Example create body

{
"name": "example-name",
"system": "EXTERNAL_SYSTEM_SERVICE_NOW",
"service_now_config": {
"standard_url": {
"scheme": "https://",
"sub_domain": "acme",
"domain": ".service-now.com"
},
"basic_auth": {
"username": "svc.moveworks",
"password": "<secret>"
}
},
"version": {
"change_description": "Create connector"
}
}