Referral Link Share (2.0)

webhook

yotpo/referral/shared

Sent when a customer shares their referral link with friends. Use it to tell the friend that someone they know likes your store.

To receive it, add yotpo/referral/shared to events when you create a filter, then subscribe the filter to your target. Yotpo sends the event to your target URL as a POST with this JSON body.

For Shopify stores that joined Yotpo Loyalty & Referrals after August 2024. Stores that joined earlier get Referral Link Share (swell/referral/share).

Payload

topic

string

The event name, yotpo/referral/shared.

name

string

The display name of the event.

website_url

string

Your store's website URL.

store_name

string

Your store's name.

from

string

The email address of the referring customer who shared their referral link.

referral_link

string

The URL of the customer’s referral link being shared.

referral_code

object

The referring customer's referral code and its sharing stats.

redemption_option

object

The reward (redemption option).

string

The customer's email address.

customer

object

The customer.

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.

X-Yotpo-Webhooks-Tenant-Id

string

required

Your store ID.

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.