Skip to content
SynupAPI
Get an API key
EVENTinteraction.review

New review received for a location

Event name: interaction.review

Sent when Synup detects a new review for one of your locations on any monitored platform (Google, Yelp, TripAdvisor, etc.). Delivered to your Webhooks URL (Reviews webhook — requires the reviews webhook permission). Location-scoped. Social-category interactions are not delivered.

Every delivery is signed. Verify X-Synup-Signature before processing — see Synup Webhooks.

Payload

NameTypeRequiredDescription
eventstringoptionalDotted event name.
timestampstringoptionalISO-8601 datetime Synup detected and processed this interaction (UTC).
account_idintegeroptionalThe Synup account that owns this location.
location_idstringoptionalSynup's numeric location ID, as a string.
dataobjectoptional
data.interactionobjectoptionalThe review or response.
data.interaction.idstringoptionalSynup's unique ID (UUID) for this interaction.
data.interaction.typestringoptional"Review" for this event.
data.interaction.contentstringoptionalFull text of the review.
data.interaction.ratingintegeroptionalReviewer rating on a normalized 1-10 scale (null for platforms without ratings). For Facebook Recommendations, 10 = positive (thumbs up), 2 = negative (thumbs down). Divide if you need a 1-5 scale.
data.interaction.author_namestringoptionalName of the person who left the review.
data.interaction.author_avatarstringoptionalURL to the reviewer's profile photo; null if the platform provides none.
data.interaction.datestringoptionalISO-8601 datetime the review was originally posted on the platform.
data.interaction.sourcestringoptionalPlatform the review came from (e.g. "maps.google.com", "yelp.com").
data.interaction.parent_idstringoptionalAlways null for reviews (used by responses to reference the original review).
data.interaction.interaction_request_idstringoptionalInternal tracking ID (UUID) for the crawl request that surfaced this review.
data.interaction.titlestringoptionalReview title if provided; usually null for Google reviews.
data.interaction.permalinkstringoptionalDirect URL to the review on the original platform.
data.interaction.categorystringoptional"Review" for standard reviews, "Recommendation" for Facebook Recommendations.
data.interaction.interaction_statusstringoptionalAlways null for reviews.
agency_account_idintegeroptionalPresent only when the account is managed by a parent agency account.
Example delivery
{
  "event": "interaction.review",
  "timestamp": "2026-06-16T05:25:52Z",
  "account_id": 10002,
  "location_id": "700001",
  "data": {
    "interaction": {
      "id": "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb",
      "type": "Review",
      "content": "From a parent's perspective, nothing matters more than knowing your child is happy and safe. Thank you for the wonderful care you provide!",
      "rating": 10,
      "author_name": "Alex Johnson",
      "author_avatar": "https://lh3.googleusercontent.com/a/placeholder-avatar",
      "date": "2026-06-15T14:58:43.540667+00:00",
      "source": "maps.google.com",
      "parent_id": null,
      "interaction_request_id": "cccccccc-dddd-eeee-ffff-000000000000",
      "title": null,
      "permalink": "https://maps.google.com/maps?cid=00000000000000000001",
      "category": "Review",
      "interaction_status": null
    }
  }
}