Review Request Eligible on Delivery

webhook

review_request.eligible.on_delivery

Sent when an order becomes eligible for a review request after it is delivered. Use it to send review requests from your own messaging platform.

To receive it, add review_request.eligible.on_delivery to events when you create a filter, then create a store subscription for each store that installed your app. Yotpo sends the event to your target URL as a POST with this JSON body.

The body has no event-name field. Read the event name from the X-Yotpo-Webhooks-Event-Type header.

Payload

trigger

object

What made the order eligible for a review request.

source_app_key

string

Your store ID.

order_id

string

Your order ID.

review_submission_url

string

A link to the review form for this order. Use it in your own review request message.

shopper_profile

object

The customer to ask for a review.

products

array of objects

The products in the order to ask about.

products

Headers

X-Yotpo-Webhooks-Event-Type

string

required

The event name.

X-Yotpo-Webhooks-Tenant-Type

string

required

The kind of account the event belongs to: store for store events.

X-Yotpo-Webhooks-Tenant-Id

string

required

The store ID (app_key) the event belongs to.

WebhookMessageId

string

required

A unique ID for the event.

WebhookMessageIdPerTarget

string

required

A unique ID for this delivery to this target. Use it to ignore duplicates.

Response

200

Return any 2xx status quickly to acknowledge the event. Without one, Yotpo retries at least 10 times with exponential backoff.