Donation Created

webhook

loyalty/donation/created

Sent when a customer redeems points for a donation to a nonprofit through the Shopping Gives integration.

To receive it, add loyalty/donation/created 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.

Donations have no coupon code, so redemption.reward_text is Donation.

Payload

topic

string

The event name, loyalty/donation/created.

name

string

The display name of the event.

website_url

string

Your store's website URL.

store_name

string

Your store's name.

redemption

object

The redemption.

redemption_option

object

The reward (redemption option).

redemption_option_id

integer

The reward (redemption option) ID.

redemption_option_name

string

The reward name.

string

The email address of the customer who donated their points.

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.