review.submitted webhook

The review.submitted webhook: a signed-in diner rated a dish of an order your backend sent, 1 to 5 stars.

A diner rated a dish of an order your backend sent, 1 to 5 stars. One event per dish rated. The webhook-id is fixed by the review and the moment it was written, so sending the same stars again sends nothing, and a changed rating is a new event with the same reviewId: keep the latest submittedAt. A test key's diner writes nothing, but their ratings are still sent as test events (reviewId starting test_).

Only reviews from your app: a review left on Tamr's own QR menu sends none. The rating only: never words or a name. From the SDK this needs the next release (requestReview); an app that draws its own chat can use it today.

The data object

FieldTypeDescription
reviewIdstring1 to 200 characters.
externalUserIdstring1 to 200 characters.
externalOrderIdstring or null1 to 200 characters.
conversationIdstring or null1 to 200 characters.
dishIdstring1 to 200 characters.
externalIdstring or null1 to 200 characters.
ratinginteger1 to 5.
submittedAtstring (date-time)

Examples

review.submitted
{
  "type": "review.submitted",
  "timestamp": "2026-11-03T12:00:00.000Z",
  "livemode": true,
  "data": {
    "reviewId": "rev_0001",
    "externalUserId": "user-88213",
    "externalOrderId": "A-99812",
    "conversationId": null,
    "dishId": "dish_kafta",
    "externalId": "SKU-1042",
    "rating": 5,
    "submittedAt": "2026-11-03T12:00:00.000Z"
  }
}

A test event

What Send a test event in the dashboard sends: livemode: false, and every id starting test_.

review.submitted, test
{
  "type": "review.submitted",
  "timestamp": "2026-11-16T12:00:00.000Z",
  "livemode": false,
  "data": {
    "reviewId": "test_review",
    "externalUserId": "test_user",
    "externalOrderId": null,
    "conversationId": null,
    "dishId": "test_dish",
    "externalId": null,
    "rating": 5,
    "submittedAt": "2026-11-16T12:00:00.000Z"
  }
}