Documentation Index

Fetch the complete documentation index at: https://docs.aifabrix.ai/llms.txt

Use this file to discover all available pages before exploring further.

External system schema

  • Updated on Aug 19, 2026
  • Published on Jun 28, 2026
  • 1 minute(s) read
  • MR
  • EB
 Prev Next

Reference for <systemKey>-system.json — authentication, system-level OpenAPI/MCP hints, roles, and certification objects.

Source of truth

  • Schema file: external-system.schema.json (shipped with the Builder CLI schema bundle)
  • Schema key: external-system-schema
  • Version: 1.14.0 (verify in schema metadata.version before citing in tickets)

Validate:

aifabrix validate <systemKey>-system.json

Top-level fields (summary)

Field Purpose
key Stable system identifier
displayName Human label
type openapi, mcp, or custom
authentication Nested auth (authType: credential | apiProvider | system | none) — deprecated; prefer authentications[]
authentications Multi-slot entries with usage (for example api, syncExecution, webhookInbound) and the same authType branches
configuration Non-secret connection settings
openapi / mcp System-level connectivity hints (spec URL, server URL) — not datasource vendor contract
subscriptions Platform compile/generate tasks after publish (not Role Assistant task DSL)
roles / permissions RBAC exposure for controller registration
certification Trust/certification metadata when present

Important rules

  • System-level openapi/mcp objects are connectivity hints. Datasource-level vendor/API provenance belongs in external datasource externalSpec.
  • Prefer authentications[] with usage separation. Flat root authentication.method was removed in schema 1.7.0; singular authentication remains for compatibility but is deprecated.
  • authType: system means platform-managed downstream auth ownership (no credential/apiProvider on the slot). authType: none injects no downstream auth. Neither equals forwarding an inbound caller token, and system is not an autonomous system actor.
  • systemKind catalog is defined in schema extension x-systemKindCatalog.
  • This page summarizes fields — it is not a second schema. When prose and JSON Schema conflict, the schema file wins.

Examples

Use Wizard output as the baseline example set for your integration folder. After manual edits, always re-run aifabrix validate and aifabrix repair --dry-run.

Related

Related articles