Preview the job board

Outcome

Create a link, valid for one hour, that shows the board's own pages with its draft appearance (or the live one without a draft), whether or not the board is published. Preview pages are never cached or indexed and do not take applications. A new link replaces the previous one. Needs the board's slug. Recruiters only.

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.job_board.preview --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/job-board/preview

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

Use an empty JSON object as input; verified credential and workspace context are separate.

Exact input schema:

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

Effects

• Stores the preview link's token (hashed) and expiry, replacing any earlier link.

Interpret the response

Open preview.url and expect 200 with the draft appearance.

The response identifier path is $.preview.url for job_board. Lists may be empty; an empty list is not a discovered target.

Exact success schema:

{
  "type": "object",
  "required": [
    "preview"
  ],
  "properties": {
    "preview": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "expiresAt": {
          "type": "string"
        },
        "showsDraft": {
          "type": "boolean"
        }
      }
    }
  }
}

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:

{}

CLI:

topolo actions validate app_topolo_recruit.job_board.preview --data @payload.json --json
topolo actions plan app_topolo_recruit.job_board.preview --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.job_board.preview --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.job_board.preview",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "preview": {
    "url": "https://recruit.test/jobs/acme?preview=2c3d576ad6bb14603ee271c2bc016a02e211b53741b1eb39",
    "expiresAt": "2026-10-05T10:00:00.000Z",
    "showsDraft": true
  }
}

HTTP 200. Open preview.url and expect 200 with the draft appearance.

Another supported 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:

{}

CLI:

topolo actions validate app_topolo_recruit.job_board.preview --data @payload.json --json
topolo actions plan app_topolo_recruit.job_board.preview --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.job_board.preview --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.job_board.preview",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "preview": {
    "url": "https://careers.acme.example?preview=6e7747d505cc74534d56e35638672f9bcc87b4d5166b99a9",
    "expiresAt": "2026-10-05T10:00:00.000Z",
    "showsDraft": false
  }
}

HTTP 200. Open preview.url and expect 200 with the draft appearance.

Refused request · board_preview_unavailable

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 is a refused request; diagnose it before retrying.

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_recruit.job_board.preview --data @payload.json --json
topolo actions plan app_topolo_recruit.job_board.preview --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 409:

{
  "error": {
    "code": "board_preview_unavailable",
    "message": "Give the job board an address before previewing it.",
    "messageKey": "recruit.api.errors.boardPreviewUnavailable",
    "locale": "en"
  }
}

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

Verify the result

• Open preview.url and expect 200 with the draft appearance.

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.
• board_preview_unavailable (HTTP 409): Give the board a slug with job_board.update first.
• 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.

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

The link expires by itself after an hour; creating another link revokes it at once.

Related actions

• Publish the job board's draft appearance: Make the board's draft appearance live: the public pages show it on their next view and the draft is cleared. Answers 409 board_no_draft when there are no unpublished changes. Publishing the board itself is job_board.publish. Recruiters only.

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.