Referral Completed (2.0)

webhook

yotpo/referral/completed

Sent when a customer refers a friend who meets your referral program's requirements. Use it to thank the customer for the referral.

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

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

Payload

topic

string

The event name, yotpo/referral/completed.

name

string

The display name of the event.

website_url

string

Your store's website URL.

store_name

string

Your store's name.

perk

object

The reward record.

referral_code

object

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

friend_referral_code

object

The referred friend's own referral code and stats.

string

The email address of the customer who made the referral.

friend

object

The friend who was referred.

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.