Work with Wix Forms to Create Services and Bookings

Customers are required to complete the booking form when signing up for a service. By default, all services use a standard booking form. You can create custom booking forms by adding fields, removing fields, or marking fields as required.

This article covers booking forms for capturing customer details during checkout, and intake forms for collecting waivers or consents before the scheduled service.

Booking forms

Due to the integration with Wix Forms APIs, you can create booking forms with a wider variety of field types, including text, dropdowns, file uploads, signatures, dates, and numbers. This functionality comes built-in with Wix Forms.

Use the following APIs to manage booking forms and submitted data:

• Forms API: Manage which fields are included in a custom booking form, including which ones customers must fill out while booking.
• Services API: Manage which booking form is connected to a service.
• Form Submissions API: Retrieve and manage data submitted by customers during the booking process.
• Bookings API: Retrieve and manage the customer's contactDetails submitted in default booking form fields.

Default booking form fields

When creating a custom booking form you need to clone the default booking form, which includes the following fields.

Field name	Customer input required	Notes
firstName	Required
lastName	Required	Can be removed in custom booking forms.
email	Required	Wix Bookings checks the format of the provided email address, but not whether it actually exists.
phone	Required	Wix Bookings checks the format of the provided phone number, but not whether it actually exists.
address.country	Conditionally required	In ISO 3166-2 code format.
address.subdivision	Conditionally required
address.city	Conditionally required
address.postalCode	Conditionally required
address.streetName	Conditionally required
address.streetNumber	Conditionally required
address.addressLine	Not required	Can be removed in custom booking forms.
address.addressLine2	Not required	Can be removed in custom booking forms.

Conditionally required fields

Customers are required to provide an address when booking a service at a location that isn't associated with the business, such as their home or office. Depending on the specified country, subdivision and/or postal code may not be required.

You can remove the entire address object in custom booking forms if the service doesn't support CUSTOMER locations. Additionally, you can always remove address.addressLine and address.addressLine2 in custom booking forms, even if the service supports booking at a CUSTOMER location.

Booking form sample flows

You could create a new service with a custom booking form, create a new booking with a filled-out booking form, or retrieve a booking's submitted booking form.

Create a new service with a custom booking form

You can follow these steps to create a new service and its associated custom booking form.

To set up a booking form:

1. Call Wix Forms' Clone Form with formId set to 00000000-0000-0000-0000-000000000000. The cloned form inherits the wix.bookings.v2.bookings namespace from the source form. Save the ID of the returned form.
2. Call Wix Forms' Update Form to add additional, custom fields to the form, or to remove optional default fields. Make sure to set fields.validation.required appropriately.
3. Call Wix Bookings' Create Service. Specify the form ID in service.form.id.

Create a booking with a filled-out booking form

You can follow these steps to create a new booking and submit its booking form on behalf of the customer.

To create a booking:

1. Call Wix Bookings' Query Services and display the services to the customer.

2. For the selected service, save form.formId.

3. Call Wix Forms' Get Form Summary. Make sure to specify the form ID.

4. Construct a valid JSON object based on the returned data. Make sure to use the exact values from formSummary.fields.target as keys in the JSON object. For example:

   Copy

5. Call Wix Bookings' Create Booking. Specify the constructed JSON object in formSubmission.

6. Listen to Wix Bookings' Booking Confirmed and save booking.formSubmissionId.

Retrieve a submitted booking form

You can follow these steps to retrieve the submitted booking form for a specific booking.

To retrieve a submitted booking form:

1. Optional: If your use case requires more filters than supported in Wix Forms' Query Submissions by Namespace, call Wix Bookings' Query Extended Booking with the relevant query filter. For example, you could filter by booking id or status. We strongly recommend including startDate in any filter you specify to ensure optimal API performance.
2. Call Wix Forms' Query Submissions by Namespace. Always filter namespace by wix.bookings.v2.bookings while setting additional query filters as required. For example, also filter by the list of form IDs retrieved from Query Extended Bookings.

Intake forms

You can require or encourage customers to complete intake forms before the scheduled service. Intake forms collect additional information such as health waivers, liability releases, or consent forms with expiration tracking.

Use the following APIs to manage intake forms with Bookings:

• Intake Forms API: Manage intake forms with expiration periods and generate shareable submission links.
• Intake Form Submissions API: Query, track, and manage intake form submissions.
• Booking Policies API: Connect intake forms to services through booking policies.

Intake form sample flows

You could create and connect an intake form to a service, or verify that a customer completed a required intake form before an appointment.

Create and connect an intake form to a service

You can create an intake form and connect it to a service. You can require the form before booking, which blocks checkout until completed, or send it after booking as optional.

To set up an intake form for a service:

1. Call Wix Forms' Create Form. Specify "namespace": "wix.waivers.forms" and include at least these formFields: firstName, email, and signature. Set pii: true and required: true in inputOptions for each of these form fields. Save the returned form ID.
2. Optional: Call Update Intake Form Expiration Period with the form ID. Specify your desired expirationPeriodInMonths. For example, 12 for annual forms.
3. Call Get Service with the service ID. Save bookingPolicy.id from the response.
4. Call Get Booking Policy with the policy ID. Save revision from the response.
5. Call Update Booking Policy with:
   • revision: The saved revision.
   • intakeFormPolicy.enabled: true.
   • intakeFormPolicy.formId: Your intake form ID.
   • intakeFormPolicy.timing: For example, AFTER_BOOKING.
   • intakeFormPolicy.completionRequirement: For example, OPTIONAL.

Verify intake form completion

Before an appointment, you can verify that the customer has a valid intake form submission.

To verify intake form completion:

1. Call Get Event with the event ID. Save externalScheduleId that maps to the service ID and contactId from participants.
2. Call Get Service with the service ID. Save bookingPolicy.intakeFormPolicy.formId from the response.
3. Call List Intake Form Data By Contacts with the contact ID and intake form ID.
4. Check if mostRecentSubmission exists with status of VALID, EXTENDED, or EXEMPT.
5. If no valid submission exists, call Create Customer Submission Link with the contact ID and intake form ID. Send the generated URL to the customer via email or SMS.

See also

• Learn more about how business owners can customize booking forms.
• Learn more about the Intake Forms app.