Applicable to Shopify integrations only.
The GDPR Customer Request event is fired when a customer makes a request regarding their data from a service provider and their 3rd party integrations.
Event Object
The webhook payload is sent in standard JSON format and contains an event object with the following information represented by key-value pairs (KVPs):
| Element | Type | Description |
|---|---|---|
event | string | Unique event name for the webhook. Set to customerRequest. |
type | string | The type of event. Possible values: customersDataRequest - request copy of data, customersRedact - request deletion of data. |
connectionId | string | The connection id associated with the webhook. Automatically assigned by Accounting Data as a Service™. See connections for more details. |
businessName | string | The business name associated with the webhook. See businesses for more details. |
serviceName | string | The name of the connected integration. See possible enum values. |
message | string | A user-friendly message related to the customer request. |
receivedPayload | object | A passthrough object related to the data request send by the service provider. |
serviceAccountRef | object | Object containing the account id and subsidiary or sub account id for the connection |
serviceAccountRef Object may include the following elements:
| Element | Type | Description |
|---|---|---|
id | string | Account id for the connection |
entityRef.id | string | Sub account or Subsidiary account id for the connection |
Example Batch Push Event Object
{
"data": {
"event": "customerRequest",
"type": "customersDataRequest",
"connectionId": "CON-8602a97d-89a6-45d2-897b-625f8b6b9e86",
"businessName": "smb8-sh",
"serviceName": "shopify",
"message": "Customer data is available through Accounting Data as a Service™ API",
"receivedPayload": {
"shop_id": 954889,
"shop_domain": "{shop}.myshopify.com",
"orders_requested": [
299938,
280263,
220458
],
"customer": {
"id": 191167,
"email": "[email protected]",
"phone": "555-625-1199"
},
"data_request": {
"id": 9999
}
}
},
"serviceAccountRef": {
"id": "DEV",
"entityRef": {
"id": "100"
}
},
"requestId": "a3b4fc83-3e24-41aa-ba99-13cab09b0b7a"
}
{
"data": {
"event": "customerReques",
"type": "customersRedact",
"connectionId": "CON-8602a97d-89a6-45d2-897b-625f8b6b9e86",
"businessName": "smb8-sh",
"serviceName": "shopify",
"message": "Customer data is available through Railz API",
"receivedPayload": {
"shop_id": 954889,
"shop_domain": "{shop}.myshopify.com",
"orders_to_redact": [
299938,
280263,
220458
],
"customer": {
"id": 191167,
"email": "[email protected]",
"phone": "555-625-1199"
}
}
},
"serviceAccountRef": {
"id": "DEV",
"entityRef": {
"id": "100"
}
},
"requestId": "a3b4fc83-3e24-41aa-ba99-13cab09b0b7a"
}