Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

event

ReviewPublishedEvent

Triggered when moderation status is set to APPROVED.


  export function wixReviewsV1_onReviewPublished(event) {
    const eventId = event.metadata.id
    const entityId = event.data.review._id;
  }

  

onReviewPublished example

onReviewPublished

void

ReviewCreated


  export function wixReviews_onReviewCreated(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onReviewCreated example

onReviewCreated

ReviewDeleted


  export function wixReviews_onReviewDeleted(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onReviewDeleted example

onReviewDeleted

ReviewModerationStatusChanged

Triggered when a review's moderation status is changed.


  export function wixReviews_onReviewModerationStatusChanged(event) {
    const eventId = event.metadata.id
    const entityId = event.data.review._id;
  }

  

onReviewModerationStatusChanged example

onReviewModerationStatusChanged

ReviewUpdated


  export function wixReviews_onReviewUpdated(event) {
    const eventId = event.metadata.id
    const entityId = event.entity._id;
  }

  

onReviewUpdated example

onReviewUpdated

---
title: Introduction
---

# Introduction

Wix Reviews events are triggered when certain events occur with reviews in your site's backend. You can write event handlers that react to these events. Event handler functions receive data that correspond to the backend event that has occurred. Use event handlers to create custom responses to sender detail events.

>**Note:** Backend events aren't triggered when previewing your site. 

## Working with Reviews Event Handlers

To add a Reviews event handler, add an **events.js** file to the **Backend** section of your site if one does not already exist. All event handler functions for your site are defined in this file.

Event handler functions are defined using the following pattern:

```js
export function <wixAppName>_<eventName>(event) { }
```

For example, an event handler that handles the creation of a review looks like this:

```js
export function wixReviews_onReviewCreated(event) { }
```



velo-events_wix-reviews.v2

AuthorType

BackendEventMetadata

ID of the entity associated with the event.

entityId

string

eventTime

Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.

triggeredByAnonymizeRequest

boolean

Media

image

video

Moderation

Indicates whether a moderator manually changed the `moderationStatus` of the review.

If the `moderationStatus` changed automatically because the review
passed the moderation rules or if moderation is turned off, this field is set to `false`.

manuallyChanged

- `APPROVED`: The review is approved and published.
- `IN_MODERATION`: The review is pending moderation. Moderation can be applied in the site owner's [Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/pending).
- `REJECTED`: The review is rejected and not visible in the site.
- `SUBMITTED`: Initial status of the review before the moderation process.

moderationStatus

ModerationModerationStatus

ModerationStatusChanged

The previous moderation status of the review.
- `APPROVED`: The review is approved and published.
- `IN_MODERATION`: The review is pending moderation. Moderation can be applied in the site owner's [Dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Freviews/pending).
- `REJECTED`: The review is rejected and not visible in the site.
- `SUBMITTED`: Initial status of the review before the moderation process.

previousModerationStatus

review

Review

Origin

The app ID of the APP review origin.
Set only when the review origin is APP.

appId

type

OriginType

Reply

_createdDate

_updatedDate

message

author

Author

content

ReviewContent

ID of the entity to review. For example, a Wix Stores product ID.

Number of site visitors who found the review helpful.

foundHelpful

number

Number of site visitors who found the review unhelpful.

foundUnhelpful

Helpfulness score.

Calculated by subtracting `foundUnhelpful` from `foundHelpful`.

helpfulness

moderation

Review namespace. Currently integrated with Wix Stores, as `stores`.

namespace

Provides information about the origin of the review.
Organic reviews are created by site visitors or members.
App reviews are created by apps even though a site visitor or member is the author of the review.
Apps can not create or update organic reviews.

origin

Counts the number of times a review has been published.
Reviews require approval before publishing, unless moderation is disabled.
When moderation is disabled, reviews are automatically approved and published.

publishCount

Platform-calculated score of review's relevance to the item. Used to sort
reviews by relevance.

relevanceScore

reply

Date and time when the review was written.
This should match `created_date`, except for reviews imported from another system.

reviewDate

Revision number, which increments by 1 each time the review is updated.
To prevent conflicting changes,
the current revision must be passed when updating the review.
Ignored when creating a review.

revision

Indicates whether the review has been verified through a Verify Product Purchase call to the Review Product catalog SPI.

verified

body

List of media items associated with the review.

Max: 10 items

media

Rating of the review.

Min: `1` <br />
Max: `5`

onReviewPublished( )