Overview Configure a webhook that automatically sends your application a JSON payload whenever an app
Target keywords (5-7)- healthcare
- AI healthcare
- healthcare AI software
- healthcare automation
- practice management AI
Full Article
API: Webhook setup for appointment notifications
Overview
Configure a webhook that automatically sends your application a JSON payload whenever an appointment is created, updated, or cancelled in the platform. This lets you keep your own calendar, CRM, or notification system in sync in real‑time.
Prerequisites
| Requirement | Details |
|---|---|
| API Key | A valid API key with Webhook Manage scope. |
| Endpoint URL | A publicly reachable HTTPS URL that can receive POST requests (e.g., https://myapp.com/webhooks/appointments). |
| SSL Certificate | The endpoint must have a valid TLS certificate (no self‑signed certs). |
| JSON Parser | Your server must be able to parse JSON payloads. |
| Access to Admin Console | You need “Administrator” or “Integration Manager” role in the SaaS portal. |
Step‑By‑Step Guide
- Log in to the Admin Console
https://app.healthai.com and sign in with your admin credentials.
- Navigate to the Webhooks page
- [Screenshot: “Integrations > Webhooks” menu highlighted]
- Create a new webhook
- [Screenshot: “+ New Webhook” blue button]
- Enter basic webhook details
Appointment Notifications.
- Endpoint URL: paste your HTTPS endpoint (e.g., https://myapp.com/webhooks/appointments).
- Secret (optional): generate a secret token if you want to verify signatures.
- Status: set to Enabled.
- [Screenshot: New webhook form with fields highlighted]
- Select event types
- appointment.created
- appointment.updated
- appointment.cancelled
- You can also check All appointment events to capture any future event types.
- [Screenshot: Event checkboxes]
- Configure request headers (optional)
Authorization: Bearer or X-Client-ID.
- [Screenshot: Header configuration modal]
- Save the webhook
- A confirmation banner appears: “Webhook created successfully.”
- [Screenshot: Blue “Save” button and success banner]
- Test the webhook
- Choose appointment.created from the dropdown and click Send Test.
- Verify that your endpoint receives a JSON payload with a 200 OK response.
- [Screenshot: Test modal and response log]
- Review delivery logs
- Use this view for ongoing troubleshooting.
- [Screenshot: Delivery logs table]
- Activate in production
- Your system will now receive real‑time appointment notifications.
Common Issues
| Symptom | Likely Cause | Fix |
|---|---|---|
| “Invalid SSL certificate” error | Endpoint uses a self‑signed or expired cert. | Install a valid TLS certificate from a trusted CA. |
| No payload received | Endpoint URL is unreachable or blocked by firewall. | Open port 443 for inbound traffic and confirm the URL is correct. |
| 401 Unauthorized response | Missing or wrong Authorization header. | Add the correct Authorization: Bearer header in step 6. |
| Payload missing expected fields | Using an outdated API version. | Ensure your API key is scoped for the latest version (v2) and re‑test. |
| Duplicate notifications | Webhook was accidentally created twice. | Delete the extra webhook from the Webhooks list. |
Related Articles
- API: Generating and rotating API keys
- API: Verifying webhook signatures
- Integrations: Setting up a CRM sync with appointment data
Still Need Help?
If you run into problems that aren’t covered above, our support team is ready to assist.
- Email: support@healthai.com
- Phone: +1 800‑555‑0123 (Mon‑Fri 9 am‑6 pm PT)
- Live chat: Click the Help icon in the bottom‑right corner of the portal.
Provide the webhook name, endpoint URL, and any error logs when you contact us – it speeds up the resolution.
Ready to stop losing patients to voicemail?
See how MedReceptionist handles your call types in a 15-minute demo.
Book Your Demo