GDPR Webhooks

🚧

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):

ElementTypeDescription
eventstringUnique event name for the webhook. Set to customerRequest.
typestringThe type of event. Possible values: customersDataRequest - request copy of data, customersRedact - request deletion of data.
connectionIdstringThe connection id associated with the webhook. Automatically assigned by Railz. See connections for more details.
businessNamestringThe business name associated with the webhook. See businesses for more details.
serviceNamestringThe name of the connected integration. See possible enum values.
messagestringA user-friendly message related to the customer request.
receivedPayloadobjectA passthrough object related to the data request send by the service provider.

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 Railz 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
			}
		}
	},
	"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"
			}
		}
	},
	"requestId": "a3b4fc83-3e24-41aa-ba99-13cab09b0b7a"
}