Webhook: CustomerGroupMembership
This family of webhooks models the lifecycle of a Customer’s belonging to a CustomerGroup. Things such as sending customised marketing materials, removing access in external systems or other cohort management actions would be good fits for events springing from these triggers.
customer_group_membership_create
Description
Fired when a Customer is added to a CustomerGroup
Payload Format
| Attribute | Type | Description |
|---|---|---|
| id | String | The identifier of this record |
| customer_id | String | The identifier of the Customer that this membership is for |
| customer_group_id | String | The identifier of the CustomerGroup this membership is within |
| expires_at | DateTime | An ISO8166 format timestamp for when this membership will expire, if any |
| updated_at | DateTime | An ISO8166 format timestamp for the last update to this record |
| created_at | DateTime | An ISO8166 format timestamp for the creation time of this record |
customer_group_membership_update
Description
Fired when a Customer’s membership of a CustomerGroup is amended. Likely to be a change to the expires_at value of the record.
Payload Format
| Attribute | Type | Description |
|---|---|---|
| id | String | The identifier of this record |
| customer_id | String | The identifier of the Customer that this membership is for |
| customer_group_id | String | The identifier of the CustomerGroup this membership is within |
| expires_at | DateTime | An ISO8166 format timestamp for when this membership will expire, if any |
| updated_at | DateTime | An ISO8166 format timestamp for the last update to this record |
| created_at | DateTime | An ISO8166 format timestamp for the creation time of this record |
customer_group_membership_destroy
Description
Fired when a Customer is removed from a CustomerGroup, either through expiry or through deliberate action. The payload contains the necessary fields for you to enact any changes on receipt of the webhook.
Payload Format
| Attribute | Type | Description |
|---|---|---|
| id | String | The identifier of the CustomerGroupMembership that was removed |