Webhook: Customer
Customer webhooks are fired in response to actions within the lifecycle of a Customer. This could be the creation of a new Customer through an order or through a manual addition, changes to names, a GDPR redaction or outright removal of the Customer.
customer_create
Description
This webhook is fired when a Customer record is created
Payload Format
| Attribute | Type | Description |
|---|---|---|
| id | String | The identifier of this Customer |
| store_id | String | The identifier of the Store this Customer belongs to |
| first_name | String | The first name of this Customer |
| last_name | String | The last or surname of this Customer |
| String | The email address of this Customer | |
| cpf_number | String | The CPF number of this Customer |
| order_count | Integer | The number of orders this Customer has made |
| 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_update
Description
This webhook is fired when a Customer record is updated
Payload Format
| Attribute | Type | Description |
|---|---|---|
| id | String | The identifier of this Customer |
| store_id | String | The identifier of the Store this Customer belongs to |
| first_name | String | The first name of this Customer |
| last_name | String | The last or surname of this Customer |
| String | The email address of this Customer | |
| cpf_number | String | The CPF number of this Customer |
| order_count | Integer | The number of orders this Customer has made |
| 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_redact
Description
This webhook is fired when a Customer has requested redaction of PII
Payload Format
| Attribute | Type | Description |
|---|---|---|
| id | String | The identifier of the Customer to redact |
marketing_consent
Description
This webhook is fired when a Customer has consented to receiving marketing communications
Payload Format
| Attribute | Type | Description |
|---|---|---|
| id | String | The identifier of this Customer |
| store_id | String | The identifier of the Store this Customer belongs to |
| first_name | String | The first name of this Customer |
| last_name | String | The last or surname of this Customer |
| String | The email address of this Customer. Null when the email channel is not consented. | |
| cpf_number | String | The CPF number of this Customer |
| order_count | Integer | The number of orders this Customer has made |
| 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 |
| phone | String | The phone number of this Customer. Null when the SMS channel is not consented. |
| marketing_consent_channels | String | Space-separated consent channels (e.g. 'email', 'sms', or 'email sms'). |
restock_notify_subscribe
Description
This webhook is fired when a Customer asks to be notified when an out-of-stock Variant is back in stock
Payload Format
| Attribute | Type | Description |
|---|---|---|
| id | String | The identifier of the Customer |
| String | The email address of the Customer | |
| first_name | String | The first name of the Customer (may be blank) |
| last_name | String | The last name of the Customer (may be blank) |
| product | RestockNotifyProduct | The Product and Variant the Customer is interested in |
Additional Data Types
RestockNotifyVariant
The out-of-stock Variant a Customer wants to be notified about
| Attribute | Type | Description |
|---|---|---|
| id | String | The identifier of the Variant the Customer wants restocked |
| name | String | The display name of the Variant |
RestockNotifyProduct
The parent Product of the out-of-stock Variant
| Attribute | Type | Description |
|---|---|---|
| id | String | The identifier of the parent Product |
| name | String | The display name of the parent Product |
| variant | RestockNotifyVariant | The Variant the Customer wants restocked |