This article describes how to implement a ScheduleOnce Integration.

Last Updated: 6/9/22

ScheduleOnce Integration

Table of Contents

Step 1: ScheduleOnce Licensing

• Purchase a license of ScheduleOnce making sure that API/Webhook functionality is included.  At the time of writing, a "Growth Plan" account with one user is sufficient.
  
  

Step 2: Create a Booking Page

• Log into the ScheduleOnce portal and clicking setup > Schedule once, then create a "Booking Page".

Step 3: Configure the Booking Form and Redirect

• Within ScheduleOnce, lick on the booking page to view the configuration options.  Click "Booking form and redirect.
• Near the bottom of the page select "Automatic Redirect": ON and set the following values:
  • Display the ScheduleOnce confirmation page for 0 seconds and then redirect to
  • When Customer schedules: https://{sitesubdomain}.geocivix.com/secure/confirmation/?type=scheduleonce
  • Send booking confirmation data to redirect page: checked
• Save Changes
• Scroll up and select the appropriate booking form (Default is ok) and click Edit form.
• Ensure that there is a hidden field titled "token" on the form.  If not look through the custom fields section for an existing field titled "token" and add it.  If a custom field is not found, you can add a custom field to the library with the following characteristics.
  • Field Type: "Single-line text field"
  • Field Name: "token"
  • Field Title: "token"
  • Do not display this field to Customers: checked.
• After creating a new custom field, make sure to add it to the form and save.

Step 4: Configure API Key

• Within ScheduleOnce, click on the gear at the top right of the nav menu and select "API & Webhooks".
• Copy the API Key to the clipboard.  Generate a new key if needed.
• Login to GeoCivix and click Site > Configuration.
• In the Site Integrations section add the Scheduler API Key and save (you may need to send this key to support@geocivix to have it added if you do not have permissions).

Step 5: Setup the Application Form

• Within ScheduleOnce click the share icon at the top right of the nav bar and select "Publish on your website".
• Select the following options:
  • Booking page: select the page you wish to use.
  • Customer Data: Customer data is passed via URL parameters: checked
  • Customer Data: prepopulate the booking form: checked
• Next copy the embed code to your clipboard.
• Within GeoCivix, navigate to the application type that needs scheduling functionality or create a new one.
• Add a new form element with the following characteristics:
  • Input Type: ScheduleOnce Calendar
  • Booking Form Embed Code: past in the code that we copied in the step before.
  • Submit

EDIT: create a tracking number named "Appointment".

Step 6: Test

• Test your new application form and ensure that no error messages are presented.

NOTE: if multiple calendars are used for different scheduling purposes, you'll need to create a separate booking page AND a separate user defined field so that they map together.