Referral Product Share Link

webhook

loyalty/referral/product_share

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.

Payload

topic

string

The event name, loyalty/referral/product_share.

name

string

The display name of the event.

website_url

string

Your store's website URL.

store_name

string

Your store's name.

string

The email of the referred friend.

from

string

The email of the referring customer.

customer

object

The customer.

referral_link

string

The referring customer's referral link.

referral_code

string

The referring customer's referral code.

product_referral_link

string

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

product

object

The shared product.

referral_discount_code

string

The discount code the referred friend gets.

published_at

date-time

When Yotpo sent the event.

Headers

X-Yotpo-Webhooks-Event-Type

string

required

The event name. Matches topic in the body.

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.