Customer Birthday

webhook

swell/customer/birthday

Sent on a customer's birthday. Use it to send a birthday email and tell the customer about any points or coupon from your Birthday campaign.

To receive it, add swell/customer/birthday 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.

Sent once a day, at 1 pm UTC.

Payload

topic

string

The event name, swell/customer/birthday.

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.

trigger_reason

string

Why the event was sent, for example scheduled.

customer

object

The customer.

string

The email address of the customer whose birthday it is.

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.