YOyotpo

Referral Product Share Link

Sent when a customer shares a product referral link. Use it to send the product share email from your own email platform.

To receive it, add loyalty/referral/product_share 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.

postWebhookloyalty/referral/product_share

Headers

X-Yotpo-Webhooks-Event-Typestring required

The event name. Matches topic in the body.

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

topicstring

The event name, loyalty/referral/product_share.

namestring

The display name of the event.

website_urlstring

Your store's website URL.

store_namestring

Your store's name.

emailstring

The email of the referred friend.

fromstring

The email of the referring customer.

referral_linkstring

The referring customer's referral link.

referral_codestring

The referring customer's referral code.

product_referral_linkstring

The referring customer's unique product referral link for this specific product.

referral_discount_codestring

The discount code the referred friend gets.

published_atstring date-time

When Yotpo sent the event.

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.