Link a provider workspace

Link a provider workspace to this Recruit workspace so its forms or surveys can be placed in stage steps. It passes to Topolo Developers as the signed-in person: Developers checks the connection between Recruit and the provider app, the person's access to both workspaces and the link between them. An admin of both workspaces links at once; anyone else's call becomes a request (outcome requested).

Outcome

Before you start

Verify identity and the pinned organization context, then discover the exact action and a granted Recruit workspace.
The required application permission is workspace:write. Hiring-team roles and record visibility are enforced separately; a workspace grant alone does not grant every Recruit action.
Organization and workspace identity come from verified context. Pass the workspace as resourceType/resourceId, separate from action input; request-body organizationId/workspaceId values cannot select an authorized scope.
The first authorized action can initialize an identity-only workspace mirror and invoke the configured workspace-created callback. It does not create an Auth workspace or grant new access.

Recruiters can perform the full hiring workflow. Hiring managers see their managed roles and candidates; interviewers see assigned interviews and their candidates. Workspace owners and organization administrators act as recruiters. Use team.me to read the caller's effective role and allowed actions.

Discover the target

topolo whoami --json
topolo actions get app_topolo_recruit.references.workspaces.link --detail --json
topolo resources topolo-recruit --json
topolo workspaces list topolo-recruit --json
topolo actions get app_topolo_recruit.team.me --detail --json

Request

POST /api/references/workspaces/link

Save input as payload.json. CLI and MCP action input includes path identifiers. The reviewed plan separates path/query fields from the HTTP body. Set RECRUIT_WORKSPACE_ID from granted resource discovery.

Inspect and test this action in the signed action console. Use its discovered schema and plan; a test response still requires the verification described below.

Input fields

Field	Required	Type	Constraints
`providerAppId`	Required	string	{"pattern":"^app_[a-z0-9]+(?:_[a-z0-9]+)+$"}
`providerWorkspaceId`	Required	string	{"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$"}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "providerAppId": {
      "type": "string",
      "pattern": "^app_[a-z0-9]+(?:_[a-z0-9]+)+$"
    },
    "providerWorkspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$"
    }
  },
  "required": [
    "providerAppId",
    "providerWorkspaceId"
  ],
  "additionalProperties": false
}

Effects

Creates the workspace link in Developers, or a request for an admin.

Interpret the response

Call references.workspaces.list and confirm linked (or requestSent).

The response identifier path is $.providerWorkspaceId for workspace. Lists may be empty; an empty list is not a discovered target.

Exact success schema:

{
  "type": "object",
  "required": [
    "providerWorkspaceId",
    "outcome"
  ],
  "properties": {
    "providerAppId": {
      "type": "string"
    },
    "providerWorkspaceId": {
      "type": "string"
    },
    "outcome": {
      "enum": [
        "linked",
        "requested",
        "approved",
        "activated",
        "unchanged"
      ]
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; Auth/workspace identity, object storage, mail and Notify dependencies are simulated. These synthetic fixtures establish no live authorization or delivery. A synthetic fixture identifier grants no access. Validate and inspect the planned request before executing. Commands with --confirm or MCP confirm:true assume the intended effect or data export has already been authorized.

Successful request

Actual dispatcher and migration-created SQLite; verified Auth/workspace context, object storage, mail and Notify dependencies are simulated. No live delivery or credential authorization is established. This complete response is a local fixture, not a deployed or delivered result.

Input · payload.json:

{
  "providerAppId": "app_topolo_forms",
  "providerWorkspaceId": "ws_other"
}

CLI:

topolo actions validate app_topolo_recruit.references.workspaces.link --data @payload.json --json
topolo actions plan app_topolo_recruit.references.workspaces.link --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.references.workspaces.link --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_recruit.references.workspaces.link",
    "input": {
      "providerAppId": "app_topolo_forms",
      "providerWorkspaceId": "ws_other"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "providerAppId": "app_topolo_forms",
  "providerWorkspaceId": "ws_other",
  "outcome": "requested"
}

HTTP 200. Call references.workspaces.list and confirm linked (or requestSent).

Refused request · person_credential_required

Input · payload.json:

{
  "providerAppId": "app_topolo_forms",
  "providerWorkspaceId": "ws_other"
}

CLI:

topolo actions validate app_topolo_recruit.references.workspaces.link --data @payload.json --json
topolo actions plan app_topolo_recruit.references.workspaces.link --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 401:

{
  "error": {
    "code": "person_credential_required",
    "message": "Sign in to Recruit to use steps from other apps.",
    "messageKey": "recruit.api.errors.connectedApps.personRequired",
    "locale": "en"
  }
}

HTTP 401. Preserve the exact response code and details. Do not claim success.

Refused request · hiring_team_role_required

Input · payload.json:

{
  "providerAppId": "app_topolo_forms",
  "providerWorkspaceId": "ws_other"
}

CLI:

topolo actions validate app_topolo_recruit.references.workspaces.link --data @payload.json --json
topolo actions plan app_topolo_recruit.references.workspaces.link --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": {
    "code": "hiring_team_role_required",
    "message": "Your hiring-team role in this workspace does not allow this action.",
    "messageKey": "recruit.api.errors.teamRoleRequired",
    "locale": "en",
    "details": {
      "teamRole": "interviewer",
      "allowedRoles": [
        "recruiter",
        "hiring_manager"
      ]
    }
  }
}

HTTP 403. Preserve the exact response code and details. Do not claim success.

Verify the result

Call references.workspaces.list and confirm linked (or requestSent).

Errors and recovery

organization_context_required (HTTP 403): Select the organization authorized by the credential; do not send an organization id in the action input.
permission_denied (HTTP 403): Grant the credential the required Recruit workspace permission.
hiring_team_role_required (HTTP 403): Ask a recruiter to give the caller a hiring-team role that allows this action (team.members.set); error.details lists the allowed roles.
workspace_required (HTTP 409): Create a Recruit workspace, or pass the workspace resource context.
invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.
person_credential_required (HTTP 401): Call it as a signed-in person: Developers answers workspace access only for a person, not an API key.
connection_not_found (HTTP 404): Connect the provider app first (references.apps.connect); an organization admin must approve.
connection_not_active (HTTP 409): The connection is not active (awaiting approval or paused); ask an organization admin.
workspace_link_required (HTTP 403): Link the provider workspace to this Recruit workspace (references.workspaces.link).
workspace_access_required (HTTP 403): The caller cannot use that workspace; choose one from references.workspaces.list.
reference_not_found (HTTP 404): Search again (references.search); the form or survey may have been deleted.
invalid_step_reference (HTTP 422): Use a forms.form from app_topolo_forms or a survey.survey from app_topolo_survey.
connected_apps_refused (HTTP 403): Read error.details.developersCode; nothing changed.
connected_apps_unavailable (HTTP 502): Developers or the provider could not be reached; retry. Nothing changed.
invalid_json (HTTP 400): Send a valid JSON object. The request is rejected before workspace resolution or record creation.
api_key_workspace_binding_required (HTTP 403): Create the API key bound to a workspace (an organization-wide key names a workspace nobody verified), then call again.
workspace_required (HTTP 400): Send the workspace the key is bound to with --resource-type workspace --resource-id <workspace id> (or the X-Topolo-Resource-Type and X-Topolo-Resource-Id headers).
workspace_forbidden (HTTP 403): Use a workspace the key is bound to; read the key's bindings in API key management.
workspace_access_insufficient (HTTP 403): Give the key the workspace permission this action needs: workspace:read to read and workspace:write to change. A delete also needs workspace:write, because the write permission is what grants the read_write level.
api_key_person_required (HTTP 403): This action needs a person signed in; an API key cannot run it. Ask the person to do it in the app.

Authentication or gateway failures may occur before the Recruit handler. Preserve the exact discovered service error, request id and credential context. The local fixtures do not establish live credential authorization.

Recovery boundary

An admin unlinks the workspaces in Topolo One's connected apps.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; Auth/workspace identity, object storage, mail and Notify dependencies are simulated. These synthetic fixtures establish no live authorization or delivery. Test capture provenance is retained with each fixture. API, database and integration outcomes require separate verification in the target environment.

Documentation history

2026-10-18: Added this action guide with reviewed request, response, permission, verification and recovery guidance from source 63171ed7c08aa066adb44cc01e64011e465302e1. Examples are retained local captures, not production execution or delivery proof.