Generate Webhooks on Production
Healthie is an API-first company and our API product is the same that our own front-end developers use to build our web and mobile apps.
To set up Webhooks, your Healthie account needs to have an active API membership. The API is available as an add-on to Healthie's Enterprise plan. To learn more, please email hello@gethealthie.com.
Looking for API Keys? Learn how to generate API Key(s) on Production and API Key(s) in Sandbox.
Set Up Webhooks
To create a new Webhook:
- Log in to your Healthie account
- Navigate go to Settings > Developer > Webhook
- Add Webhook
Note: if you do not see this setting in your production account, email hello@gethealthie.com for assistance.
You'll be prompted to Create a Webhook URL (ie. https://app.yourserver.com/webhook_endpoint)
Select your Webhook Event Type (this is required):
- appointment.created
- appointment.deleted
- appointment.updated
- applied_tag.created
- applied_tag.deleted
- care_plan.created
- care_plan.updated
- care_plan.deleted
- charting_note_addendum.created
- charting_note_addendum.updated
- charting_note_addendum.deleted
- dosepot_notification.created
- form_answer_group.created
- form_answer_group.locked
- form_answer_group.deleted
- form_answer_group.signed
- message.created
- message.deleted
- metric_entry.created
- metric_entry.updated
- metric_entry.deleted
- cms1500.created
- cms1500.updated
- cms1500.deleted
- patient.created
- patient.updated
- goal.created
- goal.updated
- goal.delated
- entry.created
- entry.updated
- entry.deleted
- comment.created
- comment.updated
- comment.deleted
- goal_history.created
- conversation_membership.created
- conversation_membership.viewed
- conversation_membership.updated
- conversation_membership.deleted
- task.created
- task.updated
- task.deleted
- billing_item.created
- billing_item.updated
- document.created
- document.updated
- document.deleted
- request_form_creation.completed
- request_form_creation.updated
- request_form_creation.deleted
- policy.created
- policy.updated
- policy.deleted
- insurance_authorization.created
- insurance_authorization.updated
- insurance_authorization.deleted
- lab_result.created
- lab_order.created
- lab_order.updated
- organization_membership.created
- organization_membership.updated
- requested_payment.created
- requested_payment.updated
- medication.created
- medication.updated
- received_fax.created
- completed_onboarding_item.created
- completed_onboarding_item.updated
- completed_onboarding_item.deleted
Adding Multiple Events to a Single Webhook (Coming Soon!)
Healthie allows a single webhook to have many events instead of just one per webhook. This functionality saves developers time in both adding webhooks with many events and in searching for specific webhook events.
On the webhooks list page the left hand column shows the number of selected events for the webhook rather than the actual event name.
When you add or edit a Webhook you’ll see a Webhook Event Types accordion that you can click to open. Once opened, you’ll see a list of events you can choose by clicking on the checkbox.
The search bar allows you to filter the Webhooks to find exactly the events you want rather than having to scroll through all of the events.
Note that validation requires a URL and a minimum of 1 event selected.
Disable or Delete Webhook(s)
To disable or delete a Webhook:
- Log in to your Healthie account
- Navigate go to Settings > Developer > Webhook
- Locate the Webhook > [...] > Edit or Delete
If disabling the Webhook:
- Edit the Webhook
- Make sure the "Enabled" checkbox is deselected
- Edit Webhook button to save changes
Enable Team Members to Generate Webhooks
To give a team member permissions to generate Webhooks within your Healthie Production account, please complete the following steps:
- Add the user to your Sandbox account: Organization > Members > Add Organization Members
- Edit their member permissions to enable the setting "Can view and manage developer features (webhooks, API keys, etc)"
- Save the member permissions
- The team member will now be able to log into their account, and self-generate Webhooks.