API ReferenceAPI Appsv1
03 - New appointment booking (instant) In Mindbody → _zapier
This event triggers when a new **appointment booking** is created in Mindbody
This event triggers when a new appointment booking is created in Mindbody. The payload provides information about the appointment details, client information, and the assigned provider.
Payload Structure
Root Object
- eventId (string) – Identifies the event type (appointmentBooking.created).
- eventInstanceOrigin (string) – Source identifier for the event.
- eventInstanceOriginationDateTime (string, ISO 8601) – Timestamp when the appointment was booked.
- eventSchemaVersion (integer) – Version of the event schema.
- messageId (string) – Unique identifier for the message.
Appointment Details
- appointmentId (integer) – Unique identifier for the appointment.
- appointmentName (string) – Name of the appointment type.
- sessionTypeId (integer) – ID of the session type for the appointment.
- status (string) – Status of the appointment (Scheduled, Completed, Cancelled, etc.).
- startDateTime (string, ISO 8601) – Scheduled start time of the appointment.
- endDateTime (string, ISO 8601) – Scheduled end time of the appointment.
- durationMinutes (integer) – Duration of the appointment in minutes.
- isConfirmed (boolean) – Whether the appointment is confirmed (true/false).
- hasArrived (boolean) – Whether the client has arrived for the appointment (true/false).
- paymentReferenceId (integer) – Payment reference ID (if applicable).
- notes (string or null) – Any additional notes related to the appointment.
Client Details
- clientId (integer) – Internal Mindbody client ID.
- clientUniqueId (integer) – Unique identifier for the client.
- clientFirstName (string) – Client’s first name.
- clientLastName (string) – Client’s last name.
- clientEmail (string) – Client’s email address.
- clientPhone (string) – Client’s phone number.
Location Details
- siteId (integer) – ID of the Mindbody site where the appointment was booked.
- locationId (integer) – ID of the location where the appointment will take place.
Provider & Staff Details
- staffId (integer) – ID of the staff member assigned to the appointment.
- staffFirstName (string) – First name of the assigned staff member.
- staffLastName (string) – Last name of the assigned staff member.
- providerId (integer or null) – ID of the service provider (if applicable).
Appointment Resources
- resources (object) – Information about resources assigned to the appointment.
- id (integer) – ID of the resource.
- name (string) – Name of the assigned resource.
Other Information
- formulaNotes (string or null) – Formula notes related to the appointment.
- genderRequested (string or null) – Gender preference for the appointment.
- icdCodes (string or null) – ICD (International Classification of Diseases) codes if applicable.
Summary
This event ensures that new appointment bookings in Mindbody are instantly updated in Zapier-powered workflows, allowing businesses to automate scheduling, notifications, and follow-ups seamlessly.
v1.4 Field Reference
Version: 1.4 | Status: Fixed | Total fields: 50
What's New in v1.4
- Client Enrichment (20 fields): clientBirthDate, clientGender, clientRedAlert, clientStatus, clientMobilePhone, clientAddressLine1, clientCity, clientState, clientPostalCode, clientCountry, clientAccountBalance, clientHomeLocationId, homeStudioName, clientSalesRepFirstName, clientSalesRepLastName, clientSalesRepId, clientNotes, clientYellowAlert, clientFirstClassDate, clientWorkExtension
- Location (1 field): locationName
- Next Visit (6 fields): nextClassName, nextClassStartDateTime, nextClassId, nextAppointmentName, nextAppointmentStartDateTime, nextAppointmentId
- Client-prefixed naming convention
- Metadata from trigger
Complete Field List
| Field | Status | Description |
|---|---|---|
| appointmentId | Unchanged | |
| appointmentName | Unchanged | |
| clientEmail | Unchanged | |
| clientFirstName | Unchanged | |
| clientId | Unchanged | |
| clientLastName | Unchanged | |
| clientPhone | Unchanged | |
| clientUniqueId | Unchanged | |
| durationMinutes | Unchanged | |
| endDateTime | Unchanged | |
| formulaNotes | Unchanged | |
| genderRequested | Unchanged | |
| hasArrived | Unchanged | |
| icdCodes | Unchanged | |
| isConfirmed | Unchanged | |
| locationId | Unchanged | |
| notes | Unchanged | |
| paymentReferenceId | Unchanged | |
| providerId | Unchanged | |
| resourceId | Unchanged | |
| resourceName | Unchanged | |
| sessionTypeId | Unchanged | |
| siteId | Unchanged | |
| staffFirstName | Unchanged | |
| staffId | Unchanged | |
| staffLastName | Unchanged | |
| startDateTime | Unchanged | |
| status | Unchanged | |
| clientBirthDate | ✅ New | Added in v1.4 client enrichment |
| clientGender | ✅ New | Added in v1.4 client enrichment |
| clientRedAlert | ✅ New | Added in v1.4 client enrichment |
| clientStatus | ✅ New | Added in v1.4 client enrichment |
| clientMobilePhone | ✅ New | Added in v1.4 client enrichment |
| clientAddressLine1 | ✅ New | Added in v1.4 client enrichment |
| clientCity | ✅ New | Added in v1.4 client enrichment |
| clientState | ✅ New | Added in v1.4 client enrichment |
| clientPostalCode | ✅ New | Added in v1.4 client enrichment |
| clientCountry | ✅ New | Added in v1.4 client enrichment |
| clientAccountBalance | ✅ New | Added in v1.4 client enrichment |
| clientHomeLocationId | ✅ New | Added in v1.4 client enrichment |
| homeStudioName | ✅ New | Added in v1.4 client enrichment |
| clientSalesRepFirstName | ✅ New | Added in v1.4 client enrichment |
| clientSalesRepLastName | ✅ New | Added in v1.4 client enrichment |
| clientSalesRepId | ✅ New | Added in v1.4 client enrichment |
| clientNotes | ✅ New | Added in v1.4 client enrichment |
| clientYellowAlert | ✅ New | Added in v1.4 client enrichment |
| clientFirstClassDate | ✅ New | Added in v1.4 client enrichment |
| clientWorkExtension | ✅ New | Added in v1.4 client enrichment |
| locationName | ✅ New | Added in v1.4 location enrichment |
| nextClassName | ✅ New | Added in v1.4 next visit enrichment |
| nextClassStartDateTime | ✅ New | Added in v1.4 next visit enrichment |
| nextClassId | ✅ New | Added in v1.4 next visit enrichment |
| nextAppointmentName | ✅ New | Added in v1.4 next visit enrichment |
| nextAppointmentStartDateTime | ✅ New | Added in v1.4 next visit enrichment |
| nextAppointmentId | ✅ New | Added in v1.4 next visit enrichment |
Related docs
Last updated April 8, 2026