post https://example.com/EVENTS.CUSTOMER.SEGMENT.ENTERED
EVENT: "EVENTS.CUSTOMER.SEGMENT.ENTERED"
HTTP method: POST
HTTP method: POST
The EVENTS.CUSTOMER.SEGMENT.ENTERED event indicates that a customer has joined a customer segment. It returns details about the customer and the segment.
When the event is used in a "Customer entered segment" distribution webhook, the data object always contains the following required objects:
customer,segment.
Additional objects are also sent depending on the purpose:
- "Notify customers about promotion" sends also the following objects:
campaign,promotion_tier,
- "Send and publish unique codes from campaign" sends also the following objects:
campaign,voucher,publication,
- "Send plain message to customers" sends only the basic objects listed above.
Webhook documentation
This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Webhook v2024-01-01 page.
Example: customer.segment.entered
{
"customer": {
"id": "cust_5P5B8oy1pxM3sTOZ8qDpmkpG",
"source_id": "a-tst",
"name": "Alex Test",
"address": {
"city": null,
"state": null,
"line_1": null,
"line_2": null,
"country": null,
"postal_code": null
},
"summary": {
"redemptions": {
"total_redeemed": 0,
"total_failed": 0,
"total_succeeded": 0,
"total_rolled_back": 0,
"total_rollback_failed": 0,
"total_rollback_succeeded": 0,
"gift": {
"redeemed_amount": 0,
"amount_to_go": 0
},
"loyalty_card": {
"redeemed_points": 0,
"points_to_go": 0
}
},
"orders": {
"total_amount": 0,
"total_count": 0,
"average_amount": 0,
"last_order_amount": 0
}
},
"loyalty": {
"points": 0,
"referred_customers": 0,
"campaigns": {}
},
"referrals": {
"total": 0,
"campaigns": []
},
"metadata": {},
"system_metadata": {},
"created_at": "2024-02-29T14:04:46.506Z",
"object": "customer"
},
"segment": {
"id": "seg_n3vVcU5t0m3rs4rEPr3C1oU5",
"name": "New Customers",
"object": "segment"
}
}