connector-definition schema

Generic External Provider Connector Engine's content model (engine-provider-connector) — domain/providerKey/connectorKind(DIRECT|HTTP)/baseUrl/auth/request-template/response-mapping.

Pull the full JSON Schema: erp schema pull connector-definition  ·  MCP: erp_get_schema {"name":"connector-definition"}

Top-level properties

Property	Type	Required	Notes
domain	string	yes	Consumer namespace, e.g. "hcm-employee-documents.signature" — any plugin/feature can register its own domain.
providerKey	string	yes	Unique per (tenant, domain) — what the consuming entity's provider_name/provider_key column resolves against.
name	string	yes
connectorKind	string	yes	one of: DIRECT, HTTP
active	boolean
isDefault	boolean
baseUrl	string
authType	string		one of: NONE, API_KEY_HEADER, BEARER_TOKEN, BASIC
authConfig	object		e.g. {headerName, secretRef} — secretRef of shape "env:VAR_NAME" resolved from environment at call time, never a literal secret stored here.
requestPath	string
httpMethod	string		one of: POST, PUT
requestTemplate	object		JSON object whose string leaves may contain tokens substituted at call time.
responseMapping	object		{providerReferencePath, statusPath, signingUrlPath} dot-paths into the vendor's JSON response.
statusMapping	object		Vendor status string -> this domain's own internal status vocabulary.
completionMode	string		one of: MANUAL_CONFIRM, POLL, WEBHOOK
pollPathTemplate	string
webhookPath	string
notes	string
ownerPlugin	string