Sign in

v1

latestOpenAPI 3.0.02026-07-24283460.8 KB
Webhooks

Add a review submitted Webhook

post/webhook/add

Query parameters

storestring required

Your REVIEWS.io public store key

apikeystring required

Your REVIEWS.io private api key

Request body

type'company_review' | 'positive_company_review' | 'negative_company_review' | 'product_review' | 'positive_product_review' | 'negative_product_review' | 'company_review_update' | 'positive_company_review_update' | 'negative_company_review_update' | 'product_review_update' | 'positive_product_review_update' | 'negative_product_review_update' required

Type of review to be notified of

urlstring required

Webhook target url

includesstring

Allow additional data to be returned in webhooks

Example request

{
  "type": "product_review",
  "url": "https://api.domain.com/new-product-review",
  "includes": "attribute_customer,attribute_company,attribute_product,tags,product,user,photo,video"
}

Response

OK

statusstring

Status

webhookstring

Webhook ID

Example response

{
  "status": "success",
  "webhook": "htv23P7M"
}