Scheduling widget: GET parameters & Javascript variables

Modified on Wed, 03 Aug 2022 at 05:28 PM

List of GET parameters & Javascript variables for your scheduling widget integration

Pop-in, iframe and minisite URL integrations can be configured through GET or JavaScript parameters:

  • lang: the language of the widget can be set: German (de), English (en), Spanish (es), French (fr), Italian (it), Japanese (ja), Dutch (nl), Portuguese (pt)
  • service: service ID (or service's external ID) that should be automatically selected when the scheduling widget is opened
  • serviceGroup: service group ID (or group's external ID) that should be automatically selected when the widget is opened
  • resource: resource ID that should be automatically selected when the booking widget is opened
  • resourceGroups: resource group ID that should be automatically selected when the widget is opened
  • staff: staff ID (or staff's external ID) that should be selected for this scheduling
  • staffGroup: staff group ID (or group's external ID) that should be pooled for this scheduling
  • gid: GoogleAnalytics tracker ID
  • cs: disables the company/location selector
  • date: preselected date (date=YYYY-MM-DD)
  • minAppointmentDate: minimum delay before an appointment can be booked (eg: absolute date minAppointmentDate=YYYY-MM-DD or minAppointmentDate=days-3 ; same syntax as in Settings JSON properties in the API)
  • maxAppointmentDate: maximum delay in which an appointment can be booked (eg: absolute date minAppointmentDate=YYYY-MM-DD or maxAppointmentDate=months-2 ; same syntax as in Settings JSON properties in the API)
  • schedulingMode
    • service: users will only have to select the service, and the staff will be automatically assigned
    • service-staff: users have to select the service then the staff
    • staff-service: users have to select the staff first then the service
  • widget form field ID: value to associate with a hidden or displayed field value (please see How to prefill data into your scheduling widget form)
  • personal data: you can pre-populate firstname, lastname, email, phone number and so on (please see related documentation)
  • tagId: tag ID to associate to the contact in CRM
  • source: customize the scheduling source (acquisition channel), for instance:
    • source=fb to register bookings from Facebook
    • source=wsite to register bookings from the company website
    • these sources will be visible into the report Appointments by Source


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article