Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.halth.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Embedded booking form

The embedded booking form is a simple and easy way to take bookings direcly on your website without redirecting to another page.

​
Demo

​
Install

Copy and paste the code below into your website builder tool. This will add the embedded booking form to your page with our recommended sizing and layout but you are welcome to customise it as needed. Note: remember to change the organisation ID 
<div style="width: 100%; height: 800px; display: flex; align-items: center; justify-content: center;">
    <iframe
    src="https://frame.embed.halth.com/?organisationId=YOUR_ORGANISATION_ID"
    style="max-width: 500px; width: 100%; height: 700px;"
  ></iframe>
</div>

​
Widget

​
Demo

The widget provides a simple on screen call to action for clients to book. It works on any page and is optimised web and mobile.

​
Install

Copy the code snippet below into the <body> tag of every page you want the embed to appear. You could also place the embed code into the <head> tag or other common component to show the embed on all pages. 
<!-- HaltH settings -->
<script>
  window.halthSettings = {
    organisationId: "YOUR_ORGANISATION_ID",
  };
</script>

<!-- HaltH embed -->
<script src="https://loader.embed.halth.com" async></script>
Remember to replace YOUR_ORGANISATION_ID with your actual organisation ID.

​
Widget embed

The default mode of the embed is to show a small circular widget in the bottom-right corner of the screen. After completing the installation above, the widget should appear on the page.

​
Inline embed

The booking form can also be embedded inline within your page content for seamless integration. After completing the installation above, you can then add this web component anywhere on the page. You may wish to place the component inside a container to control width, placement, and other styling.

​
Web component

<halth-embed />

​
Configuration

ConfigDescriptionExample
organisationIdYour unique HaltH organisation identifier."org_388zsYp1EiyAsMeAaujOwuBshot"
hideWidgetHide the widget. It will not appear in the bottom-right corner. Used for inline embed with no widget.true
locationIdSpecify the default location to book for. The location select step will be skipped."1"

​
Changes

​
8 Oct 2025
v1.1.0
Added inline embed mode
​
7 April 2025
v1.0.0
HaltH embed released