Customer Events

When subscribed to the Customer events webhook, the following event data will be received:

Event Body

Field name	Description	JSON Type	Data Type
`id`	The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout.	string
`createdDate`	A timestamp signifying when the event was generated. `Format: YYYY-MM-DDThh:mm:ss[.SSS]Z` `Note: millisecond is denoted as optional [.SSS]`	string	datetime
`type`	Event type: `customer`	string
`action`	Event action: `created` `updated`	string
`payload`	The payload of the event. The contents of this object depend on the type of event.	object	payload

`payload` object

Field name	Description	JSON Type	Data Type
`customerId`	The customer Id	string
`businessIds`	The business Id that this customer is associated with: Examples: 1. Customer is attached to first business: `action: updated` `businessIds: ["123"]` 2. Vagaro sync occurs, all business would be associated `action: updated` `businessIds: ["123", "456", "789"]` 3. Customer is removed from business: "456" `action: updated` `businessIds: ["123", "789"]`	array	string
`customerFirstName`	The customer's first name	string
`customerLastName`	The customer's last name	string
`businessGroupId`	The unique identifier for a multilocation group.	string
`email`	Customer's email address	string
`mobilePhone`	Mobile/cell phone number	string
`dayPhone`	Day phone number	string
`nightPhone`	Night phone number	string
`streetAddress`	Address	string
`city`	City name	string
`regionCode`	The state, province, or region code (e.g., "CA" for California, "CA-ON" for Ontario, "AU-NSW" for New South Wales)	string
`regionName`	The state, province, or region name (e.g., "California", "Ontario", "New South Wales").	string
`countryCode`	The country code (e.g., "US", "CA", "AU", "GB").	string
`countryName`	The country name (e.g., "United States of America", "Canada", "Australia", "United Kingdom").	string
`postalCode`	The postal or ZIP code (e.g., "90001" for USA, "M5V 2T6" for Canada, "2000" for Australia, "SW1A 1AA" for the UK).	string
`createdDate`	The date/time that the customer was created `Format: YYYY-MM-DDThh:mm:ss[.SSS]Z` `Note: millisecond is denoted as optional [.SSS]`	string	datetime
`createdBy`	User that created the customer record	string
`modifiedDate`	The date/time that the customer was modified. `Format: YYYY-MM-DDThh:mm:ss[.SSS]Z` `Note: millisecond is denoted as optional [.SSS]`	string	datetime
`modifiedBy`	User that modified/deleted the customer record	string

Example

{
    "id": "254FA623-D2B0-4785-A07D-A1A7059C74FF",
    "createdDate": "2024-03-15T00:00:00Z",
    "type": "customer",
    "action": "updated",
    "payload": {
        "customerId": "4CB231BAD3B26B7DE53FE5832A54A7B1",
        "businessIds": ["U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE="],
        "customerFirstName": "Johnny",
        "customerLastName": "Smith",
        "businessGroupId": "tYKEZF-L445YEDnCx0TIfA==",
        "email": "[email protected]",
        "mobilePhone": "9145551212",
        "dayPhone": "",
        "nightPhone": "",
        "streetAddress": "498 Edgecombe Avenue Manhattan",
        "city": "New York",
        "regionCode": "NY",
        "regionName": "New York",
        "countryCode": "US",      
        "countryName": "United States of America",      
        "postalCode": "10030",
        "createdDate": "2023-07-10T08:50:00Z",
        "createdBy": "GVkX18zRbwyUxRZaHNTYGwjK",
        "modifiedDate": "2023-08-10T08:50:00Z",
        "modifiedBy": "GVkX18zRbwyUxRZaHNTYGwjK"
    }
}

Event Body

payload object

Example

`payload` object