YOyotpo

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.

postWebhookreview_request.eligible.on_delivery

Headers

X-Yotpo-Webhooks-Event-Typestring required

The event name.

X-Yotpo-Webhooks-Tenant-Typestring required

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

X-Yotpo-Webhooks-Tenant-Idstring required

The store ID (app_key) the event belongs to.

WebhookMessageIdstring required

A unique ID for the event.

WebhookMessageIdPerTargetstring required

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

Payload

source_app_keystring

Your store ID.

order_idstring

Your order ID.

review_submission_urlstring

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

Response

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

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.