Availability Button

Turn a plain “Book Now” link on your website into “Book Now — new patient appointments available tomorrow”, updated live from your real availability. Two ways to do it: a drop-in script, or the raw data endpoint for full control.

Turn on Enable website button under New-Patient Availability in your admin Settings first. Until then both options below simply leave your plain button as-is.

Before you start

• Enable Enable website button (under New-Patient Availability) in admin Settings. It’s independent of the booking-page teaser, so you can run the button without it.
• Make sure at least one appointment type is enabled for new patients, and your practice agent is online.

The availability shown is for your first listed new-patient appointment type. It’s an indicative “soonest available” — not a held slot. By default it’s shown at day level (“tomorrow”, “Friday”); if you’d rather entice with the exact next time (“Friday at 9:40am”), the {time} placeholder below opts you in.

Option 1: Drop-in button (no coding)

Mark any link or button on your site with data-yb-button, then add the script once (replace yourpractice with your subdomain):

<a data-yb-button href="https://yourpractice.yourbooking.au/book">Book Now</a>

<script src="https://yourbooking.au/ybbutton.js"
        data-tenant="yourpractice" async></script>

The button becomes “Book Now — new patient appointments available tomorrow” and links to your booking page. Style the element however you like — it’s your markup; the script only updates the text and the link.

Customising the wording

Add data-template with any of these placeholders: {label}, {text}, {day_label}, {time}, {message}.

<a data-yb-button data-template="{label} · {text}"
   href="https://yourpractice.yourbooking.au/book">Book Now</a>

Or lead with the exact next time — “Book Now · Friday at 9:40am”:

<a data-yb-button data-template="{label} · {day_label} at {time}"
   href="https://yourpractice.yourbooking.au/book">Book Now</a>

• {label} — your button’s own text (or set data-label)
• {text} — “available today” / “available tomorrow” / “available Friday” / “available from Thursday 19 June”
• {day_label} — “today” / “tomorrow” / “Friday” / “Thursday 19 June” (weekday name within the coming week, full date once it’s a week or more out)
• {time} — the soonest exact slot, e.g. “9:40am”. Best paired with the day, e.g. {day_label} at {time}. It’s a live time behind a short cache, so treat it as an enticement — the booking flow confirms the actual slot.
• {message} — “New patient appointments are available tomorrow”

If availability can’t be shown, the button keeps your original label — so it always works.

Option 2: Use the data in your own code

Call the public endpoint and build whatever you like. No key needed; it’s read-only and safe to call straight from the browser.

GET https://yourpractice.yourbooking.au/api/v1/availability/peek

Example — enhance an existing button:

<a id="book" href="https://yourpractice.yourbooking.au/book">Book Now</a>
<script>
fetch('https://yourpractice.yourbooking.au/api/v1/availability/peek')
  .then(function (r) { return r.json(); })
  .then(function (d) {
    if (d.available) {
      document.getElementById('book').textContent =
        'Book Now — new patient appointments ' + d.text;
    }
  })
  .catch(function () {});
</script>

Response

Always returns HTTP 200. When there’s nothing to show, available is false and the other fields are null — hide your dynamic text and keep a plain button.

{
  "available": true,
  "next_date": "2026-06-12",
  "next_time": "9:40am",
  "next_datetime": "2026-06-12T09:40:00+10:00",
  "next_available": "later",
  "day_label": "Thursday 12 June",
  "text": "available from Thursday 12 June",
  "message": "New patient appointments are available from Thursday 12 June",
  "appointment_type": "Comprehensive Eye Exam",
  "booking_url": "https://yourpractice.yourbooking.au/book"
}

• available — whether there’s availability to show.
• next_date — soonest date with a new-patient slot (your local time, YYYY-MM-DD).
• next_time — soonest exact slot time on that date, compact (“9:40am”).
• next_datetime — same slot as a full ISO 8601 timestamp with your timezone offset, for your own formatting.
• next_available — “today”, “tomorrow”, or “later”.
• day_label — friendly day (“today” / “tomorrow” / weekday name like “Friday” within the coming week / “Thursday 19 June” once a week or more out).
• text — ready phrase (“available tomorrow”).
• message — full sentence (“New patient appointments are available tomorrow”).
• appointment_type — the new-patient appointment type used.
• booking_url — where to send the patient to book.

Good to know

• Cached briefly. Responses carry a 2-minute cache, so a button on every page won’t hammer the system.
• Fails quietly. If your agent is offline or there are no open slots, you get available: false — never an error in front of patients.
• Indicative, not held. The time shown is the soonest currently open; the actual slot is confirmed in the booking flow.
• Two independent toggles. The booking-page teaser and the website button are controlled separately in admin, so you can run either on its own.