Changelog

This changelog lists only significant changes, not all changes, to the Vagaro developer platform. It includes changes made to the Webhook Events platform.

---

📘

September 9, 2024

• Appointment Webhooks
  • Added formResponseIds string array that will be populated if there are forms submitted upon appointment booking

📘

August 19, 2024

• Appointment, Customer, Form Response, Transaction Webhooks
  • Clarified documentation with datetime format
    • Previous:
      Format: YYYY-MM-DDThh:mm:ss.SSZ
    • Changed to:
      Format: YYYY-MM-DDThh:mm:ss[.SSS]Z
Note: millisecond is denoted as optional [.SSS]

📘

August 16, 2024

• Appointment, Customer, Form Response, Transaction Webhooks
  • Changed businessGroupId from numeric to string
• Transaction Webhook
  • Changed userPaymentId from numeric to string
  • Changed userPaymentsMstId from numeric to string

📘

August 1, 2024

• Appointment Webhook
  • added calendarEventId

📘

July 26, 2024

• Form Response Webhook
  • updated appointmentId to string
  • added membershipId and questionType
• Transaction Webhook
  • updated appointmentId to string
  • added P: Tap to Pay option for field ccMode

📘

July 25, 2024

• Appointment Webhook
  • updated appointmentId to string
  • added Booked Inhouse option to bookingSource
  • updated sample JSON payload with new properties
• Transaction Webhook
  • added points
  • added bankAccountAmount
  • removed productSales
  • added the following purchaseType options
    • Invoice
    • Contactless Checkout
    • Cancellation Fee
    • No-Show Fee
    • Vagaro Pay Later
  • updated sample JSON payload with new properties

📘

July 22, 2024

• Appointment Webhook
  • added appointmentTypeCode and appointmentTypeName

📘

July 19, 2024

• Added more webhook general information
  • Endpoint requirements
  • Creating a webhook subscription
  • Securing webhook endpoint
  • Retry policy
  • Best practices

📘

July 18, 2024

• Appointment Webhook
  • removed appointmentCount
  • added serviceId and businessAlias
• Form Response Webhook
  • added businessAlias
• Transaction Webhook
  • added businessAlias

📘

June 17, 2024

• Clarified and changed webhook formatting
• Added JSON & Data Type columns to aid in distinguishing data types
• Customer Webhook
  • Supporting only action: updated
  • Changed businessId JSON/Data Type to an array of strings
  • The following address fields were modified to use standardize field names across different regions:
    • Changed zipCode to postalCode
    • Changed state to regionName
  • Added the following fields:
    • regionCode - State, province, regional code, (e.g., "CA" for California, "CA-ON" for Ontario, "AU-NSW" for New South Wales)
    • countryCode - Country code, (e.g., "US", "CA", "AU", "GB").
    • countryCode - Country name, (e.g., "United States of America", "Canada", "Australia", "United Kingdom")

---

📘

June 14, 2024

• Initial Release