---
title: "Points Reminder"
method: POST
path: "swell/points/reminder"
---

# Points Reminder

`POST swell/points/reminder` (webhook)

Sent after a set number of days of inactivity, when the customer is close to earning a reward. Use it to remind them.

To receive it, add `swell/points/reminder` to `events` when you [create a filter](ref:create-filter), then [create a store subscription](ref:create-subscription) for each store that installed your app. Yotpo sends the event to your target URL as a `POST` with this JSON body.

Sent once a day, at 5 pm UTC.

## Headers

- `X-Yotpo-Webhooks-Event-Type` string, required
- `X-Yotpo-Webhooks-Tenant-Type` string, required
- `X-Yotpo-Webhooks-Tenant-Id` string, required
- `WebhookMessageId` string, required
- `WebhookMessageIdPerTarget` string, required

## Payload

- object
  - `topic` string: The event name, `swell/points/reminder`.
  - `name` string: The display name of the event.
  - `website_url` string: Your store's website URL.
  - `store_name` string: Your store's name.
  - `email` string: The email address of the customer who made the referral.
  - `customer` object: The customer.
    - `total_spend_cents` integer: Total spend recorded for the customer, in cents.
    - `total_purchases` integer: Number of purchases recorded for the customer.
    - `perks_redeemed` integer: Number of rewards the customer has redeemed.
    - `last_purchase_at` string, date-time, nullable: When the customer's last recorded purchase was made, or `null`.
    - `email` string: The customer's email address.
    - `referred_by_customer` string, nullable: The email address of the customer who referred this customer, or `null` when there is no referrer.
    - `points_earned` integer: Total points the customer has earned over their lifetime.
    - `points_balance` integer: The points the customer can spend now, after this event.
    - `points_expire_at` string, date-time, nullable: When the customer's points expire, or `null` when they never expire. Follows your **Points expiration policy**: **Last Activity** (counted from the customer's last activity), **Date Earned** (the next upcoming expiration across the customer's point batches) or **Never expire** (`null`).
    - `first_name` string, nullable: The customer's first name.
    - `last_name` string, nullable: The customer's last name.
    - `last_seen_at` string, date-time, nullable: When Yotpo Loyalty last recorded activity for the customer, or `null`.
    - `third_party_id` string, nullable: The customer's ID in your e-commerce platform.
    - `referral_code` LoyaltyReferralCode: A customer's referral code and its sharing stats.
      - `code` string: The referral code.
      - `shares` integer: Total shares.
      - `facebook_shares` integer: Shares on Facebook.
      - `twitter_shares` integer: Shares on Twitter.
      - `email_shares` integer: Shares by email.
      - `emails_sent` integer: Referral emails sent.
      - `emails_viewed` integer: Referral emails opened.
      - `links_clicked_from_email` integer: Link clicks from email.
      - `links_clicked_from_twitter` integer: Link clicks from Twitter.
      - `links_clicked_from_facebook` integer: Link clicks from Facebook.
      - `orders` integer: Orders placed through the referral link.
      - `amount_cents` integer: Total value of referred orders, in cents.
      - `average_amount_cents` integer: Average value of referred orders, in cents.
      - `expires_at` string, date-time, nullable: When the code expires, or `null` when it never expires.
      - `expired` boolean: Whether the code has expired.
      - `completed_referral_customers` object[]: The friends who completed a referral with this code.
      - `email` string: The referring customer's email address.
      - `unique_clicks` integer: Unique link clicks.
      - `total_clicks` integer: Total link clicks.
  - `points_needed` integer: Points the customer still needs for the reward in `redemption_option`.
  - `redemption_option` object: The reward (redemption option).
    - `id` integer: The reward (redemption option) ID.
    - `name` string: The reward name, for example `$10 off`.
    - `description` string, nullable: The reward description shown to customers.
    - `icon` string: The reward image: an image URL or a Font Awesome class name such as `fa-dollar`.
    - `cost_text` string, nullable: The points cost as display text, for example `500 points`.
    - `amount` integer, nullable: The points the reward costs. `0` for `variable` rewards, where the customer chooses how many points to redeem.
  - `published_at` string, date-time: When Yotpo sent the event.

## Acknowledgement `200`

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

---

[API](https://skmtc.dev/yotpo/apis/app-developer-api.md) - [All operations](https://skmtc.dev/yotpo/apis/app-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yotpo/apis/app-developer-api/revisions/5bcae8239b6e?raw)