This webhook triggers when a customer moves to the ‘Loyal’ insight segment.

To subscribe to this topic your access token needs to contain the read_customers scope.

​
Payload

​
customer
object
required
Customer object with the same shape as the Customers API response
​
new_insight_segment
string
required
The name of the insight segment that the customer has moved into
​
previous_insight_segment
string | null
required
The name of the insight segment that the customer has moved from, or nullif they were not previously in a segment
​
frequency
number | null
required
The number of orders the customer has placed
​
total_spend
number | null
required
The total lifetime spend of the customer in currency subunits, e.g. $150 will be 15000
​
last_order_date
string | null
required
ISO 8601 timestamp of the customer's last order
​
average_basket_size
number | null
required
Average value of the customer's basket

​
Example

Example
{
  "id": "bff1bddb-6cd8-4c2c-9619-18744657053c",
  "topic": "program_events/customer.moved_to_loyal_segment",
  "created_at": "2018-01-01T03:00:05.000Z",
  "payload": {
    "customer": {
      "id": 6932,
      "merchant_id": "2134606599",
      "email": "jessica@example.com",
      "points_approved": 200,
      "points_pending": 300,
      "points_spent": 500,
      "rewards_claimed": 5,
      "properties": {},
      "metadata": {},
      "birthday": "1990-01-29",
      "blocked": false,
      "guest": false,
      "enrolled": true,
      "enrolled_at": "2015-12-10T03:00:00.000Z",
      "referral_id": null,
      "referred_by": null,
      "loyalty_tier_membership": null,
      "insights_segment": "Loyal",
      "referral_url": "https://prz.io/KzByQ2Fa",
      "created_at": "2016-12-10T03:00:00.000Z",
      "updated_at": "2018-01-01T03:00:00.000Z"
    },
    "frequency": 2,
    "total_spend": 4500,
    "last_order_date": "2020-11-11T19:18:39.928Z",
    "average_basket_size": 4500,
    "new_insight_segment": "Loyal",
    "previous_insight_segment": "Win Back"
  }
}