← Receivers

reviews:write

reviews family

Write a product review as a verified purchaser — identity from the signed order-history link token, never from the body

Effect
ask
Awaits an outcome — the call returns the response below.
Caller
public
The class of authority the caller must already hold, decided from the attested context with no round trip.
Cost
free
What one call costs, so you can budget before acting.
Reversible
yes
The effect can be undone by a later call.
Idempotent
yes
Safe to retry as-is.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code
Codex
Cursor
Gemini CLI
Claude Desktop
ChatGPT
curl -X POST https://one.ie/api/ask/reviews:write \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "workspace": "acme", "pid": "prod_mug", "rating": 5, "body": "Holds heat.", "token": "<uid>.<exp>.<sig>" }}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

  • workspace string required The SELLER's slug — whose shop the product and the order belong to. Bound into the token's MAC.
  • pid string required The product reviewed. Verified against an order line naming it (by pid, or by a ppid that maps to it).
  • rating number required Stars, an integer 1..5.
  • body string required The review text, 1..2000 characters after trimming. Stored trimmed; returned fenced.
  • token string required The signed order-history link token (`<uid>.<exp>.<sig>`). The ONLY source of reviewer identity.

Response

What comes back from the call.

  • ok boolean
  • rid string
  • pid string
  • state string `published` on a fresh write.
  • error string `workspace_required`, `pid_required`, `invalid_rating`, `invalid_body`, `no_db`, `link_not_configured`, `forbidden`, `link_expired`, `not_verified_purchaser`, `already_reviewed`.
  • status number

Traffic

Every call to reviews:write, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names reviews:write, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

API route 1
  • one.ie/web/src/lib/receiver-index.generated.ts:289
→

Answered by

reviews:write one.ie/web/src/lib/resolvers/reviews.ts:8 Dispatched through POST /api/ask/reviews:write, after the envelope validates the payload.

reviews family · 2 more

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace": {
      "type": "string",
      "description": "The SELLER's slug — whose shop the product and the order belong to. Bound into the token's MAC."
    },
    "pid": {
      "type": "string",
      "description": "The product reviewed. Verified against an order line naming it (by pid, or by a ppid that maps to it)."
    },
    "rating": {
      "type": "integer",
      "minimum": 1,
      "maximum": 5,
      "description": "Stars, an integer 1..5."
    },
    "body": {
      "type": "string",
      "description": "The review text, 1..2000 characters after trimming. Stored trimmed; returned fenced."
    },
    "token": {
      "type": "string",
      "description": "The signed order-history link token (`<uid>.<exp>.<sig>`). The ONLY source of reviewer identity."
    }
  },
  "required": [
    "workspace",
    "pid",
    "rating",
    "body",
    "token"
  ]
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "rid": {
      "type": "string"
    },
    "pid": {
      "type": "string"
    },
    "state": {
      "description": "`published` on a fresh write.",
      "type": "string"
    },
    "error": {
      "description": "`workspace_required`, `pid_required`, `invalid_rating`, `invalid_body`, `no_db`, `link_not_configured`, `forbidden`, `link_expired`, `not_verified_purchaser`, `already_reviewed`.",
      "type": "string"
    },
    "status": {
      "type": "number"
    }
  }
}