Opt-in customers to a referral program when they sign up
Event Type
customer/advocate_signup
Webhook Payload
{
"id": 7343536570439,
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"dob": "06-30",
"dob_last_updated_at": "2024-01-15T10:30:00Z",
"accepts_marketing": false,
"orders_count": 0,
"verified_email": false,
"total_spent": 0,
"shopify_tags": [],
"loyalty_status": "member",
"loyalty_status_last_changed_at": "2024-01-15T10:30:00Z",
"points_tally": 56348,
"credits_tally": "0.0",
"referral_url": "https://shop.com/ref/ABC123",
"referral_code": "ABC123",
"vip_tier": {
"id": 291924,
"name": "Bronze",
"threshold": 10000,
"perks": [],
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-01-01T00:00:00.000Z"
},
"points_expire_at": "December 31, 2024",
"remote_updated_at": "2024-01-15T10:30:00Z"
}
Payload Fields
Field | Type | Description |
---|---|---|
id | Integer | Customer ID |
email | String | Customer email address |
first_name | String | Customer’s first name |
last_name | String | Customer’s last name |
dob | Date or null | Customer’s date of birth, if provided |
accepts_marketing | Boolean | Shopify email subscriber status (true if opted in) |
orders_count | Integer | Total number of orders placed |
verified_email | Boolean | Whether the customer’s email address is verified |
total_spent | Float | Total amount the customer has spent |
shopify_tags | Array of strings | List of Shopify tags associated with the customer |
loyalty_status | String | Current loyalty program status (member , guest , or excluded ) |
points_tally | Integer | Current points balance |
credits_tally | Float | Current credits balance |
event_type | String | Event type that triggered the webhook (e.g. customer_vip_tier/upgraded ) |
VIP Tier Object
Field | Type | Description |
---|---|---|
id | Integer | VIP Tier ID |
name | String | VIP Tier name |
threshold | Integer | Threshold value for entering the tier (e.g., points or spending) |
perks | Array | List of perks or rewards associated with the tier |
created_at | ISO 8601 string | When the VIP Tier was created |
updated_at | ISO 8601 string | When the VIP Tier was last updated |