Getting Started

Changelog

Every meaningful change to the public Salonify API, most recent first. All entries are backwards compatible within v1 unless explicitly noted.

Public API expansion

v1
  • AddedNew scopes: products:read, products:write, gift-cards:read, gift-cards:write, loyalty:read, loyalty:write, availability:read, analytics:read, payments:read, locations:read, and locations:write.
  • AddedNew API reference resources: Products, Gift Cards, Loyalty, Availability, Payments, Analytics, and Locations.
  • AddedNew webhook events: booking.rescheduled, service.created, service.updated, staff.created, review.created, giftcard.redeemed, loyalty.points_changed, and invoice.created.
  • AddedRate-limit response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and Retry-After on 429. See Rate Limits.
  • AddedIdempotency support via the Idempotency-Key header on create endpoints, with 24-hour replay. See Idempotency.
  • AddedA public OpenAPI 3.1 document at GET /api/v1/openapi.json, powering the API Explorer, SDKs, and downloadable Postman and Insomnia collections.
  • ChangedWebhooks now retry with exponential backoff. Signature and delivery headers are unchanged and remain backwards compatible.

Public API launch

v1
  • AddedThe first public v1 REST API with key-based authentication via the X-API-Key header.
  • AddedInitial scopes: bookings, services, staff, customers (read and write), reviews:read, schedule (read and write), and business:read.
  • AddedAPI reference for Bookings, Services, Staff, Customers, Reviews, Schedule, and Business.
  • AddedHMAC-signed webhooks for core booking, service, staff, and review events (ENTERPRISE).