Halaxy Integration

Integrate Halaxy with Everbility to streamline your workflow and save time.

Prerequisites

Before you begin, ensure you meet the following requirements:

1. Verified Account: Your Halaxy account must be fully verified (identity and practice details).
2. Administrator Access: You must have the "API Key Manager" permission enabled.
3. Active Credits: You must have Halaxy credits or a credit pack to cover the API subscription fee.

Step 1: Verify Your Halaxy Account

Note: If your profile already says "Verified" or "Enabled", skip to Step 2.

Follow the Halaxy documentation to verify your account. The options to create an API key will not be provided in the Halaxy application until this is done. If you have questions regarding Halaxy verification, consult the Halaxy documentation or contact Halaxy for support.

Step 2: Subscribe to the Halaxy API

Access to the API is an "Add-on" feature that must be activated.

1. Log in to Halaxy.
2. Go to Settings > Integrations.
3. Click on the EXTERNAL tab just below the title bar.
4. Click CREATE NEW KEY on the end of the tab bar.
5. Fill in the form. The suggested name is "Everbility" and select the following permissions: "Patients", "Practitioners", "Appointments" and "Clinical Notes".
6. Copy the "Client ID" (API Client ID) and "Client Secret" (Halaxy API key) to the respective Everbility integration form fields for the Halaxy PMS.
7. Select your Halaxy "region". If your practice is based in Europe or the UK, select the "Europe or UK" regions, otherwise select the "Default" which should cover Australia, New Zealand, North America, etc. (all other regions).

Note that the "Client Secret" is only visible at the time of creation. The "Client Secret" will not be shown by Halaxy again if you navigate away. If you lose the key, it will not be recoverable; however, you can delete the "lost" key in the Halaxy key manager and create a new key at any time.