Referral Completed

webhook

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

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

Payload

topic

string

The event name, swell/referral/completed.

name

string

The display name of the event.

perk

object

The reward record.

string

The email address of the customer who made the referral.

referrer

object

The customer who made the referral.

referral_code

object

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

referred_customer

object

The friend who was referred.

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.