List Engage handoff targets

For a topolo_engage connector, list the TopoloEngage campaigns (not archived or completed) and seats in its Engage workspace, read as the caller through app_topolo_engage.campaigns.list and app_topolo_engage.seats.list. Pick one campaign id and one seat id and save them with connectors.update config campaignId and seatId; qualified leads are then enrolled there. Until both are set, Engage handoffs stay pending.

Outcome

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.engage_options --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.connectors.list --detail --json

id: connectors record id in the selected workspace.

Request

GET /api/connectors/{id}/engage-options

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

Field	Required	Type	Constraints
`id`	Required	string	connectors record id in the selected workspace. {"minLength":1,"maxLength":64}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Effects

Reads Engage campaigns and seats as the caller without changing state in Nurture or Engage.

Interpret the response

The returned identifier path is $.campaigns[].id for connector. Empty lists do not discover a target.

Confirm the campaign and seat you pick appear in the lists.

Exact success schema:

{
  "type": "object",
  "required": [
    "campaigns",
    "seats"
  ],
  "properties": {
    "campaigns": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "name",
          "status"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        }
      }
    },
    "seats": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "displayName",
          "fromAddress",
          "status"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "fromAddress": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        }
      }
    }
  }
}

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:

{
  "id": "con_69389796d0c24ede8a9d350b4dec318f"
}

CLI:

topolo actions validate app_topolo_nurture.connectors.engage_options --data @payload.json --json
topolo actions plan app_topolo_nurture.connectors.engage_options --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.connectors.engage_options --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.engage_options",
    "input": {
      "id": "con_69389796d0c24ede8a9d350b4dec318f"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "campaigns": [
    {
      "id": "cmp_open",
      "name": "MQL follow-up",
      "status": "active"
    },
    {
      "id": "cmp_draft",
      "name": "Draft",
      "status": "draft"
    }
  ],
  "seats": [
    {
      "id": "seat_1",
      "displayName": "Ada",
      "fromAddress": "ada@acme.test",
      "status": "active"
    }
  ]
}

HTTP 200. Confirm the campaign and seat you pick appear in the lists.

Refused request · permission_denied

Input · payload.json:

{
  "id": "con_69389796d0c24ede8a9d350b4dec318f"
}

CLI:

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

Captured local response · HTTP 403:

{
  "error": {
    "code": "permission_denied",
    "message": "The credential lacks workspace:read.",
    "details": {
      "requiredPermission": "workspace:read"
    }
  }
}

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

Refused request · not_found

Input · payload.json:

{
  "id": "con_missing"
}

CLI:

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

Captured local response · HTTP 404:

{
  "error": {
    "code": "not_found",
    "message": "Connector was not found in this workspace."
  }
}

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

Refused request · connector_unavailable

Input · payload.json:

{
  "id": "con_6bd980829bd04931861c8e50e819ca4b"
}

CLI:

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

Captured local response · HTTP 502:

{
  "error": {
    "code": "connector_unavailable",
    "message": "The topolo_engage connector failed: TopoloEngage seats.list failed (403)."
  }
}

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

Verify the result

Confirm the campaign and seat you pick appear in the lists.

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.
not_found (HTTP 404): List connectors to find a valid id in this workspace.
unsupported_provider (HTTP 422): Call it with the id of a topolo_engage connector from connectors.list.
connector_credential_required (HTTP 503): Call with a credential TopoloEngage accepts; this deployment may also lack the Engage URL.
connector_unavailable (HTTP 502): TopoloEngage refused or failed while checking the campaign and seat; check the credential can read the Engage workspace, 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.

Update a connector: Change a connector's capabilities, config, or status (active or paused). A paused connector keeps its settings but neither syncs nor takes part in eligibility or lead handoff. Only the fields sent change; config is replaced whole, so send every field. A topolo_engage campaignId and seatId are checked in Engage as the caller. Use connectors.disconnect to disconnect.

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.

List Engage handoff targets

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Refused request · permission_denied

Refused request · not_found

Refused request · connector_unavailable

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence