Miscellaneous

Below are the webhook store events paired with their respective data schema related to the Review Added webhook events:

Review Added Webhook Event Model

This event is triggered when a product's review has been added.

Data Schema

Example

Review Added Webhook Event Model

event

string

optional

A label or title used to identify a specific event.

Example:

review.added

merchant

number

optional

Merchant ID who installed the application on their store. Get details on the Merchant via the ID using the endpoint here

Example:

1029864349

created_at

string

optional

The date and time when a particular event was created or initiated.

Example:

Wed Jul 7 2021 15:52:52 GMT+0300

data

object

optional

type

string

optional

The categorization or classification of a review based on its nature or purpose.

Example:

rating

number

optional

A numerical or qualitative evaluation given to a product, service, or experience in a review.

Example:

content

string

optional

The written or textual portion of a review that provides detailed feedback, opinions, comments, or descriptions of a product, service, experience, or other subject of review.

Example:

Nice

customer

object

optional

product

object

optional

status

object

optional

is_available

boolean

optional

The option to indicate the product availability

Default:

false

sku

string

optional

stock-keeping unit, a unique code used to identify and manage specific products in inventory.

name

string

optional

Example:

FW180017

price

object

optional

sale_price

object

optional

currency

string

optional

Currency in which the product is purchased at.

Example:

SAR

url

string

optional

A web address that leads directly to a specific product's page or listing on a website.

Example:

https://store.test/nabilanazer/dpXnr

thumbnail

null

optional

A small, reduced-size image or visual representation of a product.

has_special_price

boolean

optional

The option to indicate the availability of special price.

Default:

false

regular_price

object

optional

favorite

null

optional

order

object

optional

date

array[string]

optional

A specific point in time within the calendar system, typically consisting of the day, month, and year.

items

array [object {2}]

optional

Review Added Webhook Event Model#

Review Added Webhook Event Model