Public docs

Shiplet documentation

Learn how to publish static previews, share review links, collect feedback, and wire feedback back into your workflow.

Workflows

Review feedback

Collect feedback on shiplets and hand it to local agents.

Authenticated viewers get the review client injected into HTML shiplets.

Feedback captures:

  • Comment
  • Page URL and pathname
  • Ticket number and label
  • Screenshot metadata when available
  • Viewport, coordinates, selected element, and capture context
  • Status and replies

Ticket labels use the PF-1, PF-2, PF-3 sequence inside each shiplet.

List feedback

curl "https://shiplet.cc/api/projects/$PROJECT_ID/review-feedback?status=New" \
  -H "Authorization: Bearer $SHIPLET_API_KEY"

Reply through MCP

async () =>
  await codemode.request({
    method: "POST",
    path: "/api/projects/project_123/review-feedback/review_123/replies",
    body: { comment: "Added a loading skeleton in the next build." },
  });

Update status through MCP

async () =>
  await codemode.request({
    method: "POST",
    path: "/api/projects/project_123/review-feedback/review_123/status",
    body: { status: "In Progress" },
  });