Customer Payload

Customer Payload Format

Each customer webhooks notification we send you uses the following format.

ChangeDateTime	This field contains the UTC timestamp of when the change was made
Customer	This field contains the latest version of the customer that was changed
Changes	This field contains an array of changes that were made to the customer. Each type of change that can be notified will be detailed in the next section

{
    "ChangeDateTime": "2018-11-16T10:46:20.7741026Z",
    "Customer": {
        "Id": 862,
        "Title": "",
        "FirstName": "Aardvark",
        "Surname": "Anderson",
        "RelatedProviderId": 1044,
        "MobileNumber": "3",
        "Company": "Animalania",
        "Email": "[email protected]",
        "ReceiveGroupEmailMarketing": false,
        "GroupEmailMarketingOptInDateTime": null,
        "GroupEmailMarketingOptInText": null,
        "ReceiveGroupSmsMarketing": true,
        "GroupSmsMarketingOptInDateTime": "2018-11-12T10:15:00",
        "GroupSmsMarketingOptInText": "Would you like to receive news and offers from Laharna by SMS",
        "ReceiveRestaurantEmailMarketing": false,
        "RestaurantEmailMarketingOptInDateTime": null,
        "RestaurantEmailMarketingOptInText": null,
        "ReceiveRestaurantSmsMarketing": true,
        "RestaurantSmsMarketingOptInDateTime": "2018-11-16T10:46:20.7115562+00:00",
        "RestaurantSmsMarketingOptInText": "Would you like to receive news and offers from Testaurant by SMS"
    },
    "Changes": [
        {
            "ChangeType": "CustomerSmsChanged",
            "OldValue": "2",
            "NewValue": "3"
        },
        {
            "ChangeType": "CustomerGroupEmailMarketingOptinChanged",
            "OldValue": true,
            "NewValue": false
        },
        {
            "ChangeType": "CustomerGroupEmailMarketingTextChanged",
            "OldValue": "Would you like to receive news and offers from Laharna by Email",
            "NewValue": null
        },
        {
            "ChangeType": "CustomerGroupEmailMarketingDateChanged",
            "OldValue": "2018-11-12T09:31:00.0000000",
            "NewValue": null
        }
    ]
}

Customer Event Types

The following changes can be notified.

Customer Contact Details Changed

This sends you a notification if a customer changes their email address or mobile number:

{
    "ChangeType": "CustomerSmsChanged",
    "OldValue": "1",
    "NewValue": "2"
},
{
    "ChangeType": "CustomerEmailChanged",
    "OldValue": "[email protected]",
    "NewValue": "[email protected]"
}

Please note, if only one value was changed, the notification will only contain the one change type.

Customer Created

This occurs if a customer is created:

{
    "ChangeType": "CustomerCreated",
    "OldValue": null,
    "NewValue": 862
}

Customer Deleted

This occurs if a customer is deleted:

{
    "ChangeType": "CustomerDeleted",
    "OldValue": false,
    "NewValue": true
}

Customer Marketing Opt-ins Changed

This occurs if a customer changes any of their SMS or Email marketing opt-ins:

{
    "ChangeType": "CustomerGroupSmsMarketingOptinChanged",
    "OldValue": false,
    "NewValue": true
},
{
    "ChangeType": "CustomerGroupSmsMarketingTextChanged",
    "OldValue": "",
    "NewValue": "Would you like to receive news and offers from Laharna by SMS"
},
{
    "ChangeType": "CustomerGroupSmsMarketingDateChanged",
    "OldValue": null,
    "NewValue": "2018-11-12T10:15:15.3434240Z"
}

Please note, if other opt-ins are changed, they will all be shown in one notification.