Skip to main content

Connector System Overview

Connectors integrate external services with Adspire.AI. Every connector follows the same registration and review process through the Adspire partner portal. A pending connector definition is visible in its developer's workspace; after internal approval, it becomes available to users generally. The definition describes the connector's scope, authentication type, store identifier, capabilities, events, configuration fields, and UI actions.

Installation scope​

Marketplace connectors are registered for one of two scopes:

  • Brand: the installation is associated with a specific brand.
  • Workspace: the installation is associated with a workspace.

The connector definition also declares whether installation requires a store identifier (store_url, shop, or none) and the authentication type used by the provider integration.

Connector capabilities​

Declare only capabilities and events the connector actually supports. Use ui_actions to describe actions exposed through Adspire; read-only queries are executed by the connector and must be implemented as described in Connector Registration and HTTP Contract.

Integration patterns​

A connector can receive provider webhooks, initiate or complete provider OAuth, expose declared actions, or combine these patterns. Verify provider callbacks and webhook signatures, keep provider credentials in connector-controlled storage, and send only the data needed for the integration.

For the current registration fields, see Connector Manifest. For registration, approval, required HTTP routes, and lifecycle behavior, see Connector Registration and HTTP Contract.