Referral Link Share

webhook

swell/referral/share

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 swell/referral/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.

Shopify stores that joined Yotpo Loyalty & Referrals after August 2024 get Referral Link Share (2.0) instead.

Payload

topic

string

The event name, swell/referral/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 customer's email address.

from

string

The email address of the referring customer.

customer

object

The customer.

referral_link

string

The referring customer's referral link.

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.