Skip to main content

Connector Manifest

A connector manifest describes scope, capabilities, and what the connector exposes. The schema below is recommended and may evolve as the Adspire.AI platform expands.

{
  "scope": "workspace | brand | org",
  "surfaces": ["actions", "signals", "resources", "ai_context"],
  "capabilities": ["ingest", "publish", "retrieve"],
  "entities": ["product", "blog", "asset", "campaign"],
  "permissions": ["read_products", "write_posts", "read_assets"],
  "ai_context": "What the connector contributes to agents",
  "ui_contexts": ["brand_sidebar", "workflow_builder"],
  "event_contracts": {
    "inbound": ["provider.topic"],
    "outbound": ["adspire.event"]
  }
}

Connector registration fields​

All connectors are registered through the Adspire partner portal and go through internal review. A pending definition is visible in the developer's workspace; after approval it becomes available to users generally. The registration API requires:

  • slug, name
  • scope: brand or workspace
  • store_field: store_url, shop, or none
  • auth_type: oauth2, api_key, or none
  • base_url: the connector's stable HTTPS service origin

Optional registration fields are manifest_version, install_fields, capabilities, events, ui_actions, and is_active. ui_actions describe actions the platform can expose; read-only resource queries are dispatched to the connector's POST /actions/query route. See Connector Registration and HTTP Contract for request authentication, lifecycle routes, and installation behavior.

Partner connector registration returns a signing_secret once when a definition is created. Store it securely; it is used to verify Adspire's signed HTTP requests and to sign installation-completion reports. It is not a public manifest field and must never be exposed to users or provider systems.