Repository navigation
Getting Started
From install to your first booking in about 15 minutes. Most of that is creating the sign-in app for your calendar service.
flowchart TD
A["1. Install and activate"] --> B["2. Set your site timezone to a city"]
B --> C{"3. Where do bookings go?"}
C -->|"Google"| G["Create a Google OAuth client, connect"]
C -->|"Outlook / Microsoft 365"| O["Create an Entra app, connect with booking access"]
C -->|"iCloud, Fastmail, Nextcloud…"| D["Make an app-specific password, connect"]
G --> E["4. Optional: add calendars that block times"]
O --> E
D --> E
E --> F["5. Choose the booking calendar and your hours"]
F --> T["6. Check your appointment types"]
T --> P["7. Add the block or shortcode to a page"]
P --> X["8. Book a test appointment"]
| Method | Steps |
|---|---|
| From WordPress.org | Plugins → Add New → search JAT Calendar Sync → Install → Activate |
| From a zip | Plugins → Add New → Upload Plugin → choose jat-calendar-sync.zip → Install → Activate |
| Moving from Anderson Appointment Booking | Install and activate as above; everything moves over by itself. See Migrating |
The plugin adds an Appointments menu with Settings, Appointment types and Bookings.
Go to Settings → General → Timezone and pick a city (for example New York), not a fixed offset like UTC−5. A fixed offset ignores daylight saving time, so your hours would shift by an hour twice a year. The settings screen and Site Health both warn if this isn't set.
You need at least one of these. Pick the calendar you live in.
| Service | What you need | Time | Guide |
|---|---|---|---|
| Google Calendar | A Google Cloud project with your own OAuth client | ~5 min | Google Calendar |
| Outlook / Microsoft 365 | A Microsoft Entra app registration | ~5 min | Outlook and Microsoft 365 |
| iCloud | An app-specific password from account.apple.com | ~2 min | iCloud and CalDAV |
| Fastmail, Nextcloud, Zoho, Yahoo, mailbox.org, other CalDAV | An app password | ~2 min | iCloud and CalDAV |
Why your own Google or Microsoft app? So no third party (including us) ever holds access to your calendar. The plugin talks to your calendar service directly from your server.
Anything else you're busy in can block times without receiving bookings:
- other Google, Outlook or CalDAV calendars (tick them in their section)
- iCal feeds: shift schedules, shared family calendars, published calendars (iCal Feeds)
| Setting | Where | Typical choice |
|---|---|---|
| Add bookings to | Settings → Where bookings go | Your main calendar |
| Open booking only as far as | Settings → Where bookings go | Leave off, or choose your work schedule (Shift-Work Mode) |
| Hours for each day | Settings → When people can book |
09:00-17:00, breaks as 09:00-12:00, 13:00-17:00
|
| Free time before / after | Settings → When people can book | 0 / 15 minutes |
| Minimum notice | Settings → When people can book | 4–24 hours |
| Book up to | Settings → When people can book | 14–30 days ahead |
Every setting is listed in the Settings Reference.
One type is created for you. Under Appointments → Appointment types you can rename it, change its length, add a price, questions, a location or a video call, or add more types. See Appointment Types and Questions.
| Method | How |
|---|---|
| Block editor | Add the Appointment Booking block |
| Shortcode |
[jat_booking], or [jat_booking type="consult"] for one type |
More options in Block and Shortcode.
- Open the page in a private window and book a time with your own email address.
- Check: the event appears in your booking calendar, you get the owner email, and the visitor email arrives with a manage link.
- Open the manage link, move the appointment, then cancel it. The calendar event should move, then disappear.
- Look at Tools → Site Health: the JAT Calendar Sync checks should be green.
| Check | Where to look |
|---|---|
| Times appear on the booking page | Your page |
| "Right now: booking is open through …" (shift-work mode only) | Settings → Where bookings go |
| No red messages | Settings, and Tools → Site Health |
| Hourly task running | Settings shows "Last checked your calendar … ago" |
Related: Calendar Services · Settings Reference · Troubleshooting
JAT Calendar Sync · free and open source (GPLv2 or later) · GitHub · by Jeremy Anderson Tech · This wiki is generated from docs/wiki/ in the repository; edit it there.
Set up
- Getting Started
- Calendar Services
- Google Calendar
- Outlook and Microsoft 365
- iCloud and CalDAV
- iCal Feeds
- Migrating from Anderson Appointment Booking
Use
- Appointment Types and Questions
- Availability Rules
- Shift-Work Mode
- Payments with Stripe
- Rescheduling and Cancelling
- Emails and Reminders
- Styling and Theming
- Block and Shortcode
- Settings Reference
Help
Developers