Connector Systems A–D
Per-system connector reference (AMAZON_CONNECT → DOVETAIL). 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_AMAZON_CONNECT
Config block: amazon_connect_config
Amazon Connect connection settings, used when system is EXTERNAL_SYSTEM_AMAZON_CONNECT. Set exactly one system-specific config.
Example create body:
EXTERNAL_SYSTEM_ARIBA
Config block: ariba_config
SAP Ariba connection settings, used when system is EXTERNAL_SYSTEM_ARIBA. Set exactly one system-specific config.
Set at most one of oauth2_client_credentials, on_prem_auth.
Example create body:
EXTERNAL_SYSTEM_AUTHHUB
Config block: authhub_config
AuthHub connection settings, used when system is EXTERNAL_SYSTEM_AUTHHUB. Set exactly one system-specific config.
Example create body:
EXTERNAL_SYSTEM_AXERO
Config block: axero_config
Axero connection settings, used when system is EXTERNAL_SYSTEM_AXERO. Set exactly one system-specific config.
Set at most one of api_key_auth, on_prem_auth.
Example create body:
EXTERNAL_SYSTEM_BACKSTAGE
Config block: backstage_config
Backstage connection settings, used when system is EXTERNAL_SYSTEM_BACKSTAGE. Set exactly one system-specific config.
Set at most one of oauth2_jwt_grant, on_prem_auth.
Example create body:
EXTERNAL_SYSTEM_BEYOND_TRUST
Config block: beyond_trust_config
BeyondTrust connection settings, used when system is EXTERNAL_SYSTEM_BEYOND_TRUST. Set exactly one system-specific config.
Example create body:
EXTERNAL_SYSTEM_BMC_REMEDY
Config block: bmc_remedy_config
BMC Remedy (including Remedy Helix) connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDY. Set exactly one system-specific config.
Example create body:
EXTERNAL_SYSTEM_BMC_REMEDYFORCE
Config block: bmc_remedyforce_config
BMC Remedyforce connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDYFORCE. Set exactly one system-specific config.
Example create body:
EXTERNAL_SYSTEM_BMC_REMEDY_DWP
Config block: bmc_remedy_dwp_config
BMC Remedy DWP connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDY_DWP. Set exactly one system-specific config.
Set at most one of cookie_auth, on_prem_auth.
Example create body:
EXTERNAL_SYSTEM_BOX
Config block: box_config
Box connection settings, used when system is EXTERNAL_SYSTEM_BOX. Set exactly one system-specific config.
Set at most one of oauth2_refresh_token, client_credentials_auth.
Example create body:
EXTERNAL_SYSTEM_BOX_LEGACY
Config block: box_legacy_config
Box (legacy) connection settings, used when system is EXTERNAL_SYSTEM_BOX_LEGACY. Set exactly one system-specific config.
Example create body:
EXTERNAL_SYSTEM_BRAINSTORM
Config block: brainstorm_config
Brainstorm connection settings, used when system is EXTERNAL_SYSTEM_BRAINSTORM. Set exactly one system-specific config.
Set at most one of oauth2_client_credentials, api_key_auth, on_prem_auth.
Example create body:
EXTERNAL_SYSTEM_BRIGHTSPOT
Config block: brightspot_config
Brightspot connection settings, used when system is EXTERNAL_SYSTEM_BRIGHTSPOT. Set exactly one system-specific config.
Set at most one of client_credentials_header_auth, on_prem_auth.
Example create body:
EXTERNAL_SYSTEM_CHERWELL
Config block: cherwell_config
Cherwell connection settings, used when system is EXTERNAL_SYSTEM_CHERWELL. Set exactly one system-specific config.
Example create body:
EXTERNAL_SYSTEM_COMAROUND
Config block: comaround_config
ComAround connection settings, used when system is EXTERNAL_SYSTEM_COMAROUND. Set exactly one system-specific config.
Set at most one of comaround_oauth2, on_prem_auth.
Example create body:
EXTERNAL_SYSTEM_CONCUR
Config block: concur_config
SAP Concur connection settings, used when system is EXTERNAL_SYSTEM_CONCUR. Set exactly one system-specific config.
Set at most one of oauth2_refresh, on_prem_auth.
Example create body:
EXTERNAL_SYSTEM_CONFLUENCE
Config block: confluence_config
Confluence Cloud connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE. Set exactly one system-specific config.
Set at most one of service_account_method, forge_app_method.
Example create body:
EXTERNAL_SYSTEM_CONFLUENCE_LEGACY
Config block: confluence_legacy_config
Confluence (legacy) connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE_LEGACY. Set exactly one system-specific config.
Example create body:
EXTERNAL_SYSTEM_CONFLUENCE_SERVER
Config block: confluence_server_config
Confluence Server connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE_SERVER. Set exactly one system-specific config.
Set at most one of basic_auth, on_prem_auth, api_key_auth.
Example create body:
EXTERNAL_SYSTEM_CONNECT_WISE
Config block: connect_wise_config
ConnectWise connection settings, used when system is EXTERNAL_SYSTEM_CONNECT_WISE. Set exactly one system-specific config.
Example create body:
EXTERNAL_SYSTEM_CONTENTFUL
Config block: contentful_config
Contentful connection settings, used when system is EXTERNAL_SYSTEM_CONTENTFUL. Set exactly one system-specific config.
Set at most one of api_key_auth, on_prem_auth.
Example create body:
EXTERNAL_SYSTEM_CONTENT_GATEWAY_SYSTEM
Config block: content_gateway_system_config
Content Gateway System connection settings, used when system is EXTERNAL_SYSTEM_CONTENT_GATEWAY_SYSTEM. Set exactly one system-specific config.
Set at most one of oauth2_client_credentials_grant, on_prem_auth, api_key_auth, oauth2_jwt_grant, external_auth.
Example create body:
EXTERNAL_SYSTEM_COUPA
Config block: coupa_config
Coupa connection settings, used when system is EXTERNAL_SYSTEM_COUPA. Set exactly one system-specific config.
Example create body:
EXTERNAL_SYSTEM_DOVETAIL
Config block: dovetail_config
Dovetail connection settings, used when system is EXTERNAL_SYSTEM_DOVETAIL. Set exactly one system-specific config.
Set at most one of basic_auth, on_prem_auth.
Example create body: