GDPR Webhooks

You will receive notifications via a webhook whenever there are new events associated with a GDPR or its status.

Customer Data Request

The GDPR Customer Request event is the quickest way for you to receive notifications when one of your customers requested their data.

Railz sends an event upon a response from the service provider the request was made from.

The payload for this event will contain all the connection information and request summary. You can identify this specific event by the properties "event": "customerRequest" and "type":"customersDataRequest".

{
  "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"
}

📘

receivedPayloadis a passthrough object from the service provider.

Customer Redact

The GDPR Customer Request event is the quickest way for you to receive notifications when one of your customers requests to delete their data.

Railz sends an event upon a response from the service provider the request was made from.

The payload for this event will contain all the connection information and request summary. You can identify this specific event by the property "event": "customerRequest" and "type":"customersRedact".

{
  data: {
    event: 'customerRequest',
    type: 'customersRedact',
    connectionId: 'CON-321bdd26-f865-4c88-ae8f-d84f114453d9',
    businessName: 'smb10-sh',
    serviceName: 'shopify',
    message: 'The data redaction has been processed',
    receivedPayload: {
      shop_id: 954889,
      shop_domain: '{shop}.myshopify.com',
      customer: {
        id: 191167,
        email: '[email protected]',
        phone: '555-625-1199'
      },
      'orders_to_redact': [
        299938,
        280263,
        220458
      ]
    }
  }
}

📘

receivedPayloadis a passthrough object from the service provider.