referral.completed Coming soon

EVENTReferrals

Fires when a guest who joined through a member's referral meets the program's referral condition, and the referrer's reward is issued. The referral program isn't designed in full yet, so this payload may change before it ships.

data.object holds the referral's id, referrer_member_id, referred_member_id, qualifying_order_id and completed_at.

Event JSON

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18{
  "id": "b7a3e1d9-2c6f-4b48-9e05-3d8f1a6c2e94",
  "type": "referral.completed",
  "created_at": "2026-11-18T17:26:31Z",
  "api_version": "v1",
  "livemode": true,
  "brand_id": "e5a1c7d9-2f4b-4c8e-a3d6-8b0f1e9c2a57",
  "data": {
    "object": {
      "id": "e2d9b6a4-8f1c-4a57-b3e0-5c7d2f9a1e86",
      "referrer_member_id": "3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40",
      "referred_member_id": "7a3e9c1f-4b6d-4f82-a0e5-2c8d1b7f9e36",
      "qualifying_order_id": "0d5c8a3f-6e2b-4d71-9f4a-8b1e3c7d5a29",
      "completed_at": "2026-11-18T17:26:31Z"
    },
    "previous_attributes": {}
  }
}