YOyotpo

Referral Share Reminder

Sent when a referred friend hasn't made a purchase after a set number of days. Use it to remind them to use the referral link, so both customers get a reward.

To receive it, add swell/referral/share/reminder 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.

postWebhookswell/referral/share/reminder

Headers

X-Yotpo-Webhooks-Event-Typestring required

The event name. Matches topic in the body.

X-Yotpo-Webhooks-Tenant-Typestring required

The kind of account the event belongs to: store for store events.

X-Yotpo-Webhooks-Tenant-Idstring required

The store ID (app_key) the event belongs to.

WebhookMessageIdstring required

A unique ID for the event.

WebhookMessageIdPerTargetstring required

A unique ID for this delivery to this target. Use it to ignore duplicates.

Payload

topicstring

The event name, swell/referral/share/reminder.

namestring

The display name of the event.

website_urlstring

Your store's website URL.

store_namestring

Your store's name.

emailstring

The email address of the recipient of the referral link (the friend).

referral_linkstring

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

referral_codestring

The referring customer's referral code.

fromstring

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

published_atstring date-time

When Yotpo sent the event.

Response

Return any 2xx status quickly to acknowledge the event. Without one, Yotpo retries at least 10 times with exponential backoff.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.