Appointment Events

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

`event` object

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: `appointment`	string
`action`	Event action: `created` `updated` `deleted`	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
`appointmentId`	The unique appointment id	string
`startTime`	The date/time the appointment will begin at. `Format: YYYY-MM-DDThh:mm:ss[.SSS]Z` `Note: millisecond is denoted as optional [.SSS]`	string	datetime
`endTime`	The date/time the appointment will end at. `Format: YYYY-MM-DDThh:mm:ss[.SSS]Z` `Note: millisecond is denoted as optional [.SSS]`	string	datetime
`bookingStatus`	The current status of the appointment: `Accepted` `Awaiting Confirmation` `Cancel` `Confirmed` `Deleted` `Denied` `Need Acceptance` `No Show` `PersonalOff` `Ready to Start` `Service Complete` `Service In Progress` `Show`	string
`serviceTitle`	The service title of the appointment	string
`serviceId`	The unique service id	string
`calendarEventId`	The event ID if the appointment is booked in a calendar event, otherwise null	string
`amount`	Amount for the appointment	numeric	currency
`eventType`	An event type for the appointment/class `Appointment` `Class`	string
`onlineVsInhouse`	From where is the appointment/class booked `Online: if appointment/class booked from business pages/my site/yelp` `Inhouse: if appointment/class booked from calendar`	string
`appointmentTypeCode`	The appointment type code: `NR` `NNR` `RR` `RNR`	string
`appointmentTypeName`	The appointment type name: `New Request` `New Non Request` `Return Request` `Return Non Request`	string
`customerId`	The customer Id associated with this appointment	string
`bookingSource`	Appointment booking source `Vagaro Marketplace` `Vagaro Daily Deal` `Vagaro Featured` `Vagaro Text/Email Marketing` `Booked on Instagram` `Booked on Facebook` `Booked on Yelp` `Booked on Apple Maps` `Booked on Google` `Booked Inhouse`	string
`serviceProviderId`	The service provider Id performing the service	string
`businessId`	The business Id performing the service	string
`businessAlias`	The alias (nickname) of the business	string
`businessGroupId`	The unique identifier for a multilocation group.	string
`serviceCategory`	The parent service name of the booked service.	string
`createdDate`	The date/time the appointment was created. `Format: YYYY-MM-DDThh:mm:ss[.SSS]Z` `Note: millisecond is denoted as optional [.SSS]`	string	datetime
`createdBy`	The user that created the appointment	string
`modifiedDate`	The date/time the appointment was modified. `Format: YYYY-MM-DDThh:mm:ss[.SSS]Z` `Note: millisecond is denoted as optional [.SSS]`	string	datetime
`modifiedBy`	The user that updated/deleted the appointment	string
`formResponseIds`	An array of form response ids if there are forms submitted upon appointment booking	array	string

Example

{
	"id": "254FA623-D2B0-4785-A07D-A1A7059C74FF",
	"createdDate": "2024-02-15T00:00:00Z",
	"type": "appointment",
	"action": "created",
	"payload": {
		"appointmentId": "2dwfErtmMAFxe6hoCnQStw==",
		"startTime": "2024-02-15T05:25:00Z",
		"endTime": "2024-02-15T06:25:00Z",
		"bookingStatus": "Confirmed",
		"serviceTitle": "Color & Haircut",
		"serviceId": "PqiJDBWJ4tHFpnSHPZpy~w==",
		"calendarEventId": null,
		"appointmentCount": 1,
		"amount": 0.0,
		"customerId": "2dwfErtmMAFxe6hoCnQStw==",
		"eventType": "Service",
		"onlineVsInhouse": "Online",
		"appointmentTypeCode": "NR",
		"appointmentTypeName": "New Request",
		"bookingSource": "Vagaro Marketplace",
		"serviceProviderId": "2dwfErtmMAFxe6hoCnQStw==",
		"businessId": "U2FsdGVkX18zRbwyUxRZaHNTYGwjKCpDdAkKP4eUDsE=",
		"businessAlias": "Vagaro Salon Studios",
		"businessGroupId": "tYKEZF-L445YEDnCx0TIfA==",
		"serviceCategory": "Hair Care",
		"createdDate": "2023-07-10T08:50:00Z",
		"createdBy": "GVkX18zRbwyUxRZaHNTYGwjK",
		"modifiedDate": null,
		"modifiedBy": null,
		"formResponseIds": [
			"Tkhj89234jadkjal23rnjlasfdsakjlewtewt234fw4="
		]
	}
}

event object

payload object

Example

`event` object

`payload` object