IT adminsHOW-TO
It-Admin
How to connect a ScheduleOnce booking calendar to a GeoCivix application type, so applicants can book an appointment as part of applying.
On this page
- Licensing
- Create a booking page
- Configure the booking form and redirect
- Configure the API key
- Set up the application form
- Test
Workflow events in the workflow editor. On Calendar Booking runs when someone books an appointment through a connected calendar. Example from a GeoCivix demo portal. Names are hidden, and your local portal may look a little different.
Before you start
You need administrative access to both ScheduleOnce and GeoCivix, and a ScheduleOnce license that includes API and webhook functionality.
01 | Licensing |
1 | Make sure your ScheduleOnce license includes API and webhook functionality. At the time of writing a Growth Plan account with one user is enough. |
02 | Create a booking page |
- Sign in to ScheduleOnce, go to Setup > ScheduleOnce, and create a booking page.
03 | Configure the booking form and redirect |
- In ScheduleOnce, select the booking page to open its configuration, then select Booking form and redirect.
- Near the bottom of the page set Automatic Redirect to ON and enter the following:
- Display the ScheduleOnce confirmation page for
0seconds, then redirect - When a customer schedules:
https://{sitesubdomain}.geocivix.com/secure/confirmation/?type=scheduleonce - Send booking confirmation data to redirect page: checked
- Save your changes.
- Scroll up, select the booking form you want to use — the default is fine — and select Edit form.
- Check that the form has a hidden field named
token. If it doesn't, look in the custom fields section for an existing field namedtokenand add it. If there isn't one, create a custom field with these characteristics:
- Field type: single-line text field
- Field name:
token - Field title:
token - Do not display this field to customers: checked
- After creating the custom field, add it to the form and save.
04 | Configure the API key |
- In ScheduleOnce, select the gear icon at the top right of the navigation menu and select API & Webhooks.
- Copy the API key. Generate a new one if you need to.
- Sign in to GeoCivix and select Site > Configuration.
- In the Site Integrations section, add the Scheduler API key and save. If you don't have permission to do this, contact GeoCivix support and they can add it for you.
05 | Set up the application form |
- In ScheduleOnce, select the share icon at the top right of the navigation bar and select Publish on your website.
- Select the following:
- Booking page: the page you want to use
- Customer data is passed via URL parameters: checked
- Prepopulate the booking form: checked
- Copy the embed code.
- In GeoCivix, go to the application type that needs scheduling, or create a new one.
- Add a new form element with these characteristics, then submit:
- Input type: ScheduleOnce Calendar
- Booking form embed code: the code you copied
- Create a tracking number named Appointment.
06 | Test |
- Test the application form and check that no error messages appear.
Caution
If you use several calendars for different scheduling purposes, each one needs its own booking page and its own user-defined field, so that the two map together.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article