Topolo Docs Topolo Platform
Open workspace

List connector providers

List the remote audience systems a Nurture workspace can optionally connect, the capabilities each supports and the non-secret config fields it needs. Nurture works fully without any connector. Capabilities: contact_source (connectors.sync copies remote contacts into Nurture, source connector, source_ref crm:<id>); suppression_sync (connectors.sync pushes unsubscribed, hard_bounce, complaint and manual_block events for those contacts to TopoloCRM, and eligibility.reserve also reserves in TopoloCRM, stricter wins); interaction_writeback (records sends on the CRM timeline; nothing writes yet); lead_handoff (TopoloCRM: a task per newly qualified CRM-linked lead; TopoloEngage: enrol each newly qualified lead into the chosen campaign from the chosen seat, creating the Engage contact when missing).

Outcome

List the remote audience systems a Nurture workspace can optionally connect, the capabilities each supports and the non-secret config fields it needs. Nurture works fully without any connector. Capabilities: contact_source (connectors.sync copies remote contacts into Nurture, source connector, source_ref crm:<id>); suppression_sync (connectors.sync pushes unsubscribed, hard_bounce, complaint and manual_block events for those contacts to TopoloCRM, and eligibility.reserve also reserves in TopoloCRM, stricter wins); interaction_writeback (records sends on the CRM timeline; nothing writes yet); lead_handoff (TopoloCRM: a task per newly qualified CRM-linked lead; TopoloEngage: enrol each newly qualified lead into the chosen campaign from the chosen seat, creating the Engage contact when missing).

Before you start

  • Verify identity and pin the intended organization and environment before discovering the action.
  • Discover a granted Nurture workspace. The application permission is workspace:read; required workspace access is read. A permission alone does not supply a workspace grant.
  • Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.

Discover the target

topolo whoami --json
topolo actions get app_topolo_nurture.connectors.catalog --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json

Request

GET /api/connectors/catalog

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

Use an empty JSON object; verified credential and resource context are separate.

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Effects

  • Reads the static provider catalog without changing state.

Interpret the response

The returned identifier path is $.providers[].provider for connector_provider. Empty lists do not discover a target.

Confirm the provider you want lists the capabilities you plan to enable.

Exact success schema:

{
  "type": "object",
  "required": [
    "providers"
  ],
  "properties": {
    "providers": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "provider",
          "capabilities",
          "configFields"
        ],
        "properties": {
          "provider": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "capabilities": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "contact_source",
                "suppression_sync",
                "interaction_writeback",
                "consent",
                "lead_handoff"
              ]
            }
          },
          "configFields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "maxLength": {
                  "type": "integer"
                },
                "required": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      }
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.

Successful request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_nurture.connectors.catalog --data @payload.json --json
topolo actions plan app_topolo_nurture.connectors.catalog --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.connectors.catalog --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_nurture.connectors.catalog",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "providers": [
    {
      "provider": "topolo_crm",
      "name": "TopoloCRM",
      "capabilities": [
        "contact_source",
        "suppression_sync",
        "interaction_writeback",
        "lead_handoff"
      ],
      "configFields": [
        {
          "key": "crmWorkspaceId",
          "label": "CRM workspace ID",
          "maxLength": 128,
          "required": true
        }
      ]
    },
    {
      "provider": "topolo_engage",
      "name": "TopoloEngage",
      "capabilities": [
        "lead_handoff"
      ],
      "configFields": [
        {
          "key": "engageWorkspaceId",
          "label": "Engage workspace ID",
          "maxLength": 128,
          "required": true
        },
        {
          "key": "campaignId",
          "label": "Engage campaign",
          "maxLength": 128,
          "required": false
        },
        {
          "key": "seatId",
          "label": "Engage seat",
          "maxLength": 128,
          "required": false
        }
      ]
    }
  ]
}

HTTP 200. Confirm the provider you want lists the capabilities you plan to enable.

Refused request · invalid_input

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "unsupported": "value"
}

CLI:

topolo actions validate app_topolo_nurture.connectors.catalog --data @payload.json --json
topolo actions plan app_topolo_nurture.connectors.catalog --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 422:

{
  "error": {
    "code": "invalid_input",
    "message": "The input does not match the action schema.",
    "details": [
      {
        "code": "unrecognized_keys",
        "keys": [
          "unsupported"
        ],
        "path": [],
        "message": "Unrecognized key: \"unsupported\""
      }
    ]
  }
}

HTTP 422. Preserve the refusal details and do not claim success.

Verify the result

  • Confirm the provider you want lists the capabilities you plan to enable.

Errors and recovery

  • organization_required (HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.
  • permission_denied (HTTP 403): Grant the credential the required Nurture workspace permission.
  • workspace_required (HTTP 409): Create a Nurture workspace, or pass the workspace resource context.
  • invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.

Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.

Recovery boundary

This action does not change service state.

  • Connect a provider: Connect one provider to this workspace with the chosen capabilities and its non-secret config (topolo_crm: crmWorkspaceId; topolo_engage: engageWorkspaceId, plus optional campaignId and seatId, checked in Engage). Calls act as the caller's credential; no secret is stored. One connector per provider per workspace; reconnecting a disconnected one reactivates it with the new settings. Capabilities: contact_source (connectors.sync copies remote contacts into Nurture, source connector, source_ref crm:<id>); suppression_sync (connectors.sync pushes unsubscribed, hard_bounce, complaint and manual_block events for those contacts to TopoloCRM, and eligibility.reserve also reserves in TopoloCRM, stricter wins); interaction_writeback (records sends on the CRM timeline; nothing writes yet); lead_handoff (TopoloCRM: a task per newly qualified CRM-linked lead; TopoloEngage: enrol each newly qualified lead into the chosen campaign from the chosen seat, creating the Engage contact when missing).

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.