With our Webhook integration, you can programmatically receive a notification every time a review is published, delivered to any endpoint you specify.
You can use this feature alongside our Write Review Link tool to:
- track review submissions
- trigger post-review incentives once a customer has submitted their review
- schedule reminder emails to customers who haven't submitted a review
- prevent sending further review invitation emails to customers who have already submitted a review
This Webhook integration feature is best used alongside our Write Review Link. This article is intended as a high-level overview of this feature and will outline:
- how to set custom parameters on the Write Review Link
- how to use the Webhook integration to receive notifications for new review submissions
- putting it all together so that your Webhook integration can receive notifications for new review submissions and the custom parameters you've set on the Write Review Link
How to set custom parameters on the Write Review Link
Step 1:
Log into your Brand Management Platform dashboard.
Step 2:
Scroll down to the Review Acquisition section on the left side of the dashboard, and click ‘Write Review Links'.
Step 3:
Select the relevant Write Review Link subject (i.e. the listing where you want customers to leave a review).
Step 4:
Select a method to generate your review links. You can either do this:
- manually
- with code (recommended if you're working with a developer)
Step 5:
Add the relevant parameters that you would like to set in your Write Review Link. The following parameters will also be sent to your webhook end point:
- cmegi (this is a reporting identifier that you can set)
- any parameters prefixed with "kv_" (e.g. kv_customer_id, kv_product_id)
How to set up the Webhook integration
Step 1:
Log into your Brand Management Platform dashboard.
Step 2:
Scroll down to the Integrations section on the left side of the dashboard, and click 'Webhooks'.
Step 3:
Add the URL endpoint that will be receiving notifications when new review events occur.
This endpoint will receive a notification every time a review is approved. This includes organically submitted reviews and also reviews that are collected through our Review Invitation Tools (like our Write Review Link).
Putting it all together:
An example of what a Write Review Link could look like can be found below:
In this case the:
- customer email - customer@example.com
- displayName - Jane
- cmegi - post_purchase_sms
- invoiceNumber - INV-0000
- kv_customer_id - 010101
- kv_product_id - socks001
When a customer uses a link like the one above and their review is published, your specified Webhook endpoint will receive a payload like this:
{
"event": "ReviewWasPublished",
"payload": {
"reviewId": "000-000",
"rating": 5,
"authorDisplayName": "Jane",
"reviewUrl": "https://www.productreview.com.au/reviews/000-000",
"queryStringParameters": {
// These values come from write-review link you send to the customer.
// If the reviewer arrives directly on ProductReview, this object will be empty.
"cmegi": "post_purchase_sms",
// For extra values, you must prefix the query string parameter with "kv_".
// They'll all be sent as strings.
"kv_customer_id": "010101",
"kv_product_id": "socks001"
}
}
}queryStringParameters object will be empty.Using the payload above, you can now configure your marketing automations to:
- track review submissions
- trigger post-review incentives once a customer has submitted their review
- schedule reminder emails to customers who haven't submitted a review
- prevent sending further review invitation emails to customers who have already submitted a review