Member Webhooks
Receive Member Data updates in a more scalable way
Triggering Events
Below are the following events that trigger Customer's webhooks
On Creation: member_created
Any update on the member object: member_updated
On Delete: member_deleted
{
"member":{
"id":4200000,
"recreational":false,
"medical":false,
"email":"[email protected]",
"last_visit_date":null,
"first_name":"john",
"last_name":"doe",
"address1":null,
"address2":null,
"city":null,
"zip":null,
"balance":4000,
"allowed_sms":true,
"allowed_email":false,
"allowed_loyalty":true,
"merchant_id":420,
"region":null,
"birthday":"1990-06-23",
"gender":"female",
"hipaa_acknowledged":null,
"hipaa_acknowledged_date":null,
"phone_number":"814-420-4200",
"member_profiles":[
{
"id": 1100000,
"created_at": "2023-02-02T20:12:24.827Z",
"updated_at": "2023-02-02T20:12:24.827Z",
"member_id": 1039276,
"merchant_id": 6,
"first_name": "john",
"last_name": "doe",
"email": "[email protected]",
"phone_number": "814-420-4200",
"address1": null,
"address2": null,
"city": null,
"region": null,
"zip": null,
"pos_user": "4200000-400-420-400-2000000",
"pos_type": "pos_name",
"location": null,
"purpose": null,
"birthday": null,
"response": null,
"last_updated_at": null,
"allowed_sms": true,
"allowed_email": true,
"tags": {},
"primary_location": null,
"gender": null,
"referred_by_id": null,
"medical_card_expiration": null,
"country": null,
"address_type": null,
"hipaa_acknowledged": null,
"allowed_loyalty": null,
"medical_card_expiration_old": null,
"referral_source": null,
"springpay_account_connected": false,
"import_id": null
]
],
"has_signature":false,
"location_list":[
],
"custom_group_list":[
],
"compliance_workflow":false,
"wallet_link":"https://gamma.loyaltywallet.club/?m=0000/#/profile"
},
"event_name":"member_created"
}{
"event_name": "member_updated",
"member": {
"id": 1493195,
"recreational": false,
"medical": false,
"email": "[email protected]",
"last_visit_date": "2024-05-30T17:42:43.000Z",
"first_name": "Yaakov",
"last_name": "Griner",
"address1": null,
"address2": null,
"city": null,
"zip": null,
"allowed_sms": null,
"allowed_email": true,
"allowed_loyalty": true,
"merchant_id": 13,
"region": null,
"birthday": "1996-09-19",
"gender": "male",
"hipaa_acknowledged": null,
"hipaa_acknowledged_date": null,
"phone_number": "561-479-6923 ",
"member_profiles": [
{
"id": 2633438,
"created_at": "2024-11-07T22:44:38.658Z",
"updated_at": "2024-11-07T22:44:38.658Z",
"member_id": 1493195,
"merchant_id": 13,
"first_name": "Yaakov",
"last_name": "Griner",
"email": "[email protected]",
"phone_number": "5614796923",
"address1": null,
"address2": null,
"city": null,
"region": null,
"zip": null,
"pos_user": "719e1f06",
"pos_type": "wallet",
"location": null,
"purpose": null,
"birthday": "1996-09-19",
"last_updated_at": "2024-11-07T22:44:38.657Z",
"allowed_sms": null,
"allowed_email": true,
"tags": {
"custom_group_list": "",
"location_list": "410,greenline",
"interest_list": "",
"brand_list": "kusk-care,laura-s-buds",
"category_list": "flower,dried-flower",
"discount_list": ""
},
"primary_location": null,
"gender": "male",
"referred_by_id": null,
"medical_card_expiration": null,
"country": null,
"address_type": null,
"hipaa_acknowledged": null,
"allowed_loyalty": null,
"medical_card_expiration_old": null,
"referral_source": null,
"springpay_account_connected": false,
"import_id": null
}
],
"has_signature": false,
"location_list": [
"410",
"greenline"
],
"custom_group_list": [],
"compliance_workflow": false,
"wallet_link": "https://gamma.loyaltywallet.club/?m=wgb4gkshgrbegbu/#/profile",
"balance": 3618
}
}| Attribute | Definition | Sample Response |
|---|---|---|
| id | the member's unique identifier | |
| recreational | boolean if the member is type: recreational | true, false |
| medical | boolean if the member is type: medical | true, false |
| the member's email address | valid email format | |
| last_visit_date | the member's recorded last visit date | e.g. 2020-04-20T19:33:03.880Z |
| first_name | the member's first name | |
| last_name | the member's last name | |
| address1 | the member's address 1 | |
| address2 | the member's address 2 | |
| city | the city where the member is located | |
| zip | the member's zip code | |
| allowed_sms | determines if the member has opted in to sms marketing | true, false, null, pending |
| allowed_email | determines if the member has opted in to email marketing | true, false, null, pending |
| allowed_loyalty | boolean if the member is opted into loyalty (earn points) | true, false, null, pending |
| merchant_id | the merchant's account id | |
| region | the member's region | |
| birthday | the member's birthday | YYYY-MM-DD |
| gender | the member's gender | female, male, other |
| hipaa_acknowledged | determines the member's acknowledgment of the HIPAA checkbox on the springbig wallet | true, false, null |
| hipaa_acknowledged_date | the date when the HIPAA checkbox was acknowledged | e.g. 2020-04-20T20:12:24.827Z |
| phone_number | the member's phone number as a string value | valid 10-digit number e.g. 814-420-4200 |
| member_profiles | an array of member profile objects that belong to the member based on matching identifiers like, pos_user, phone_number, email | |
| has_signature | determines if the member has submitted an explicit enrollment in the form of a virtual signature | true, false |
| location_list | comma-separated string values of locations the member is tagged to based on visits or explicit values posted via API | "boca, washington" |
| custom_group_list | comma-separated string values of custom_group taggings that the member is assigned to based on explicit API submission or import submissions | "january-2023-vip-loyalist" |
| wallet_link | the member's wallet URL link | |
| balance | member's point balance. This only shows on an update event. | |
| event_name | trigger event type | member_created, member_updated, member_deleted |
Updated 10 months ago
Did this page help you?