Skip to content
StartupBuilderby Startups.Studio
Business
Changelog
Events

Review.withheld

Emitted each time a Review is withheld.

Review.withhold emits Review.withheld when it completes on a Review.

PropertyValue
Emitted byReview.withhold
NounReview
MovesReview submitted to withheld; Review published to withheld
WakesNone.

Payload

Each delivery is an Event record. data holds what Review.withhold returns, and previous holds the state it left.

FieldTypeRequiredDescription
namestringrequiredReview.withheld.
atdatetimerequiredWhen it happened.
seqintegerIts position in the namespace, one more than the Event before; any seq is a cursor into the history.
datajsonrequiredThe Thing as the Action left it.
data.reviewReviewrequiredThe Review, now withheld.
data.review.ratingintegerrequiredThe score, from 1 to 5.
data.review.bodytextThe reviewer’s words.
data.review.venuestringThe venue it was posted on, by id; empty for the Startup’s own Site.
data.review.displayConsentbooleanTrue once the reviewer agreed it may be shown on the Startup’s own Pages.
data.review.statusstringrequiredWhere it stands; a removed Review is kept, never deleted.
data.review.customerCustomerThe Customer who wrote it, when known.
data.previous.statusstringrequiredThe status before this Event: submitted.

Example

JSON
{
  "$id": "https://api.sb/kilnbakery.com/events/event_1",
  "$type": "Event",
  "name": "Review.withheld",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "review": {
      "$id": "https://api.sb/kilnbakery.com/reviews/review_1",
      "$type": "Review",
      "rating": 1,
      "body": "Example body",
      "venue": "Example venue",
      "displayConsent": true,
      "status": "withheld",
      "customer": "customer_1"
    },
    "previous": {
      "status": "submitted"
    }
  },
  "seq": 1
}