Reference

Customer events

View as Markdown

Six events fire on the customer resource. Each delivers the full customer object on data.object. Update events also include data.previous_attributes with the prior values of the changed fields.

EVENT TYPES
TypeFires when
customer.createdA customer is added — through the app, the API, or a CRM sync.
customer.updatedAny field on the customer changes. previous_attributes lists changed fields only.
customer.archivedA customer is archived. The object remains but stops appearing in the active list.
customer.health_score_droppedHealth score drops by 10 points or more between calculations.
customer.at_riskCustomer’s at-risk flag is set, either by Pi or by a CSM.
customer.churnedCustomer is marked churned.
PAYLOAD
customer.health_score_dropped
1{
2  "id": "evt_2nQv...",
3  "type": "customer.health_score_dropped",
4  "data": {
5    "object": {
6      "id": "cus_2N...",
7      "display_id": 4218,
8      "name": "Acme Corp",
9      "health_score": 38,
10      "previous_health_score": 72,
11      "at_risk": true,
12      "churned": false,
13      "owner_email": "csm@yourdomain.com"
14    },
15    "previous_attributes": {
16      "health_score": 72,
17      "at_risk": false
18    }
19  }
20}