Who can do this?
Included in Halaxy API subscription
Webhooks allow different software systems to communicate with each other in real time. By using webhooks in Halaxy, events that occur in your Halaxy account (such as creating a new appointment or patient) can automatically trigger updates in other systems that you use - all without needing manual entry or repeated checks.
For your practice, webhooks can:
-
Save time by reducing double data entry
-
Automatically sync your records and tools
-
Improve accuracy by ensuring the latest information is always shared across systems.
With webhooks, information flows instantly, seamlessly and securely between Halaxy and your external platforms.
When an event happens in Halaxy, a Halaxy webhook automatically sends the details of that event to another system. This is done by sending a message (known as a payload) to a specific address of that external system, called an endpoint URL.
Example use cases for webhooks:
|
Event in Halaxy |
External action triggered |
|---|---|
|
Appointment is created |
Send a message to a Slack channel |
|
Invoice is edited |
Update invoice in accounting software |
|
Patient profile is created |
Add patient as a new contact in email software |
Note: This feature is only available for practices who are already subscribed to Halaxy API.
-
Click Settings > Integrations, then at the top, click the Webhooks tab.
-
In the top right, click Create Webhook.
-
In the pop-up, configure the following:
-
Endpoint URL: The URL from your external system that will receive this webhook's event data.
-
Event: The event to trigger this webhook.
-
Contact Email: Your contact email address, in case of troubleshooting.
-
Reason for Subscription: A quick description of why this webhook was created.
-
Authentication Header: Paste the authentication header of your request.
-
-
Click Save.
You have successfully created a webhook.
Updated