Single delivery channel used by Healthie for all webhook
notifications. The specific event is identified by the
`event_type` field in the JSON body (e.g. `appointment.created`),
and the affected record is identified by `resource_id` plus the
GraphQL type name in `resource_id_type` (one of `Appointment`,
`FormAnswerGroup`, `Entry`, or `Note` per the Healthie docs).
Update events also carry a `chang
A transcript is available for an appointment recording.
Content-Type: application/json
AvailabilityCreated
An availability slot was created.
Content-Type: application/json
AvailabilityUpdated
An availability slot was updated.
Content-Type: application/json
AvailabilityDeleted
An availability slot was deleted.
Content-Type: application/json
PatientCreated
A patient (client) record was created.
Content-Type: application/json
PatientUpdated
A patient (client) record was updated.
Content-Type: application/json
PatientMerged
Two patient (client) records were merged.
Content-Type: application/json
AppliedTagCreated
A tag was applied to a resource.
Content-Type: application/json
AppliedTagDeleted
A tag was removed from a resource.
Content-Type: application/json
CourseMembershipCreated
A course membership was created.
Content-Type: application/json
CourseMembershipUpdated
A course membership was updated.
Content-Type: application/json
CourseMembershipDeleted
A course membership was deleted.
Content-Type: application/json
FeatureToggleCreated
A feature toggle was created.
Content-Type: application/json
FeatureToggleUpdated
A feature toggle was updated.
Content-Type: application/json
FeatureToggleDeleted
A feature toggle was deleted.
Content-Type: application/json
NotificationContactCreated
A notification contact was created.
Content-Type: application/json
NotificationContactUpdated
A notification contact was updated.
Content-Type: application/json
NotificationContactDeleted
A notification contact was deleted.
Content-Type: application/json
NotificationSettingCreated
A notification setting was created.
Content-Type: application/json
NotificationSettingUpdated
A notification setting was updated.
Content-Type: application/json
NotificationSettingDeleted
A notification setting was deleted.
Content-Type: application/json
OtherIdNumberCreated
An other ID number was created on a user.
Content-Type: application/json
OtherIdNumberUpdated
An other ID number was updated on a user.
Content-Type: application/json
OtherIdNumberDeleted
An other ID number was deleted from a user.
Content-Type: application/json
FormAnswerGroupCreated
A form answer group (form submission) was created.
Content-Type: application/json
FormAnswerGroupDeleted
A form answer group was deleted.
Content-Type: application/json
FormAnswerGroupSigned
A form answer group was signed.
Content-Type: application/json
FormAnswerGroupLocked
A form answer group was locked.
Content-Type: application/json
FormAnswerGroupUnlocked
A form answer group was unlocked.
Content-Type: application/json
AppointmentFormAnswerGroupConnectionCreated
A form was linked to an appointment.
Content-Type: application/json
AppointmentFormAnswerGroupConnectionUpdated
An appointment-to-form linkage was updated.
Content-Type: application/json
AppointmentFormAnswerGroupConnectionDeleted
An appointment-to-form linkage was deleted.
Content-Type: application/json
RequestedFormCompletionCreated
A requested form completion was created.
Content-Type: application/json
RequestedFormCompletionUpdated
A requested form completion was updated.
Content-Type: application/json
RequestedFormCompletionDeleted
A requested form completion was deleted.
Content-Type: application/json
CompletedOnboardingItemCreated
A completed onboarding item was recorded.
Content-Type: application/json
CompletedOnboardingItemUpdated
A completed onboarding item was updated.
Content-Type: application/json
CompletedOnboardingItemDeleted
A completed onboarding item was deleted.
Content-Type: application/json
CustomModuleFormCreated
A custom module form (template) was created.
Content-Type: application/json
CustomModuleFormUpdated
A custom module form was updated.
Content-Type: application/json
CustomModuleFormDeleted
A custom module form was deleted.
Content-Type: application/json
CustomModuleCreated
A custom module (form field) was created.
Content-Type: application/json
CustomModuleUpdated
A custom module was updated.
Content-Type: application/json
CustomModuleDeleted
A custom module was deleted.
Content-Type: application/json
GeneratedFormAnswerGroupCreated
A generated form answer group was created (e.g. by automation).
Content-Type: application/json
ConversationCreated
A messaging conversation was created.
Content-Type: application/json
ConversationUpdated
A messaging conversation was updated.
Content-Type: application/json
ConversationMembershipCreated
A user was added to a conversation.
Content-Type: application/json
ConversationMembershipDeleted
A user was removed from a conversation.
Content-Type: application/json
ConversationMembershipViewed
A conversation membership was marked viewed (read receipt).
Content-Type: application/json
MessageCreated
A message was created.
Content-Type: application/json
MessageDeleted
A message was deleted.
Content-Type: application/json
ScheduledMessageSent
A scheduled message was sent.
Content-Type: application/json
BillingItemCreated
A billing item was created.
Content-Type: application/json
BillingItemUpdated
A billing item was updated.
Content-Type: application/json
BillingItemDeleted
A billing item was deleted.
Content-Type: application/json
RequestedPaymentCreated
A requested payment was created.
Content-Type: application/json
RequestedPaymentUpdated
A requested payment was updated.
Content-Type: application/json
RequestedPaymentDeleted
A requested payment was deleted.
Content-Type: application/json
RecurringPaymentCreated
A recurring payment was created.
Content-Type: application/json
RecurringPaymentUpdated
A recurring payment was updated.
Content-Type: application/json
ChargeBackCreated
A chargeback was created.
Content-Type: application/json
ChargeBackUpdated
A chargeback was updated.
Content-Type: application/json
ChargeBackDeleted
A chargeback was deleted.
Content-Type: application/json
ClaimSubmissionCreated
A claim submission was created.
Content-Type: application/json
ClaimSubmissionUpdated
A claim submission was updated.
Content-Type: application/json
ClaimSubmissionDeleted
A claim submission was deleted.
Content-Type: application/json
Cms1500Created
A CMS-1500 claim was created.
Content-Type: application/json
Cms1500Updated
A CMS-1500 claim was updated.
Content-Type: application/json
Cms1500Deleted
A CMS-1500 claim was deleted.
Content-Type: application/json
InsuranceAuthorizationCreated
An insurance authorization was created.
Content-Type: application/json
InsuranceAuthorizationUpdated
An insurance authorization was updated.
Content-Type: application/json
InsuranceAuthorizationDeleted
An insurance authorization was deleted.
Content-Type: application/json
PolicyCreated
An insurance policy was created.
Content-Type: application/json
PolicyUpdated
An insurance policy was updated.
Content-Type: application/json
PolicyDeleted
An insurance policy was deleted.
Content-Type: application/json
AcceptedInsurancePlanCreated
An accepted insurance plan was added.
Content-Type: application/json
AcceptedInsurancePlanDeleted
An accepted insurance plan was removed.
Content-Type: application/json
SuperBillCreated
A super bill was created.
Content-Type: application/json
SuperBillUpdated
A super bill was updated.
Content-Type: application/json
SuperBillDeleted
A super bill was deleted.
Content-Type: application/json
StripeCustomerDetailCreated
A Stripe customer detail was created.
Content-Type: application/json
StripeCustomerDetailUpdated
A Stripe customer detail was updated.
Content-Type: application/json
StripeCustomerDetailDeleted
A Stripe customer detail was deleted.
Content-Type: application/json
AllergySensitivityCreated
An allergy/sensitivity record was created.
Content-Type: application/json
AllergySensitivityUpdated
An allergy/sensitivity record was updated.
Content-Type: application/json
AllergySensitivityDeleted
An allergy/sensitivity record was deleted.
Content-Type: application/json
CarePlanCreated
A care plan was created.
Content-Type: application/json
CarePlanUpdated
A care plan was updated.
Content-Type: application/json
CarePlanDeleted
A care plan was deleted.
Content-Type: application/json
CarePlanActivated
A care plan was activated.
Content-Type: application/json
CarePlanDeactivated
A care plan was deactivated.
Content-Type: application/json
ChartingNoteAddendumCreated
A charting note addendum was created.
Content-Type: application/json
ChartingNoteAddendumUpdated
A charting note addendum was updated.
Content-Type: application/json
ChartingNoteAddendumDeleted
A charting note addendum was deleted.
Content-Type: application/json
DiagnosisCreate
A diagnosis was created (documented spelling preserves Healthie's `create` verb).
Content-Type: application/json
DiagnosisUpdated
A diagnosis was updated.
Content-Type: application/json
DiagnosisDeleted
A diagnosis was deleted.
Content-Type: application/json
GoalCreated
A goal was created.
Content-Type: application/json
GoalUpdated
A goal was updated.
Content-Type: application/json
GoalDeleted
A goal was deleted.
Content-Type: application/json
GoalTemplateCreated
A goal template was created.
Content-Type: application/json
GoalTemplateUpdated
A goal template was updated.
Content-Type: application/json
GoalTemplateDeleted
A goal template was deleted.
Content-Type: application/json
GoalHistoryCreated
A goal history entry was created.
Content-Type: application/json
GoalHistoryDeleted
A goal history entry was deleted.
Content-Type: application/json
MedicationCreated
A medication record was created.
Content-Type: application/json
MedicationUpdated
A medication record was updated.
Content-Type: application/json
MedicationDeleted
A medication record was deleted.
Content-Type: application/json
LabOrderCreated
A lab order was created.
Content-Type: application/json
LabOrderUpdated
A lab order was updated.
Content-Type: application/json
LabResultCreated
A lab result was created.
Content-Type: application/json
LabResultUpdated
A lab result was updated.
Content-Type: application/json
MetricEntryCreated
A metric entry was created.
Content-Type: application/json
MetricEntryUpdated
A metric entry was updated.
Content-Type: application/json
MetricEntryDeleted
A metric entry was deleted.
Content-Type: application/json
ReferralCreated
A referral was created.
Content-Type: application/json
ReferralUpdated
A referral was updated.
Content-Type: application/json
ReferralDeleted
A referral was deleted.
Content-Type: application/json
FamilyHistoryConditionCreated
A family history condition was created.
Content-Type: application/json
FamilyHistoryConditionUpdated
A family history condition was updated.
Content-Type: application/json
FamilyHistoryConditionDeleted
A family history condition was deleted.
Content-Type: application/json
EntryCreated
An entry (journal/log) was created.
Content-Type: application/json
EntryUpdated
An entry was updated.
Content-Type: application/json
EntryDeleted
An entry was deleted.
Content-Type: application/json
PrescriptionUpdated
A prescription was updated.
Content-Type: application/json
ReferringPhysicianCreated
A referring physician was created.
Content-Type: application/json
ReferringPhysicianUpdated
A referring physician was updated.
Content-Type: application/json
ReferringPhysicianDeleted
A referring physician was deleted.
Content-Type: application/json
DosespotNotificationCreated
A DoseSpot e-prescribing notification was created.
Content-Type: application/json
DocumentCreated
A document was created.
Content-Type: application/json
DocumentUpdated
A document was updated.
Content-Type: application/json
DocumentDeleted
A document was deleted.
Content-Type: application/json
SentFaxCreated
A sent fax record was created.
Content-Type: application/json
SentFaxUpdated
A sent fax record was updated.
Content-Type: application/json
SentFaxStatusChanged
A sent fax's status changed.
Content-Type: application/json
ReceivedFaxCreated
A received fax record was created.
Content-Type: application/json
FolderSharingCreated
A folder sharing entry was created.
Content-Type: application/json
FolderSharingDeleted
A folder sharing entry was deleted.
Content-Type: application/json
TaskCreated
A task was created.
Content-Type: application/json
TaskUpdated
A task was updated.
Content-Type: application/json
TaskDeleted
A task was deleted.
Content-Type: application/json
LocationCreated
A location was created.
Content-Type: application/json
LocationUpdated
A location was updated.
Content-Type: application/json
LocationDeleted
A location was deleted.
Content-Type: application/json
OrganizationInfoCreated
Organization info was created.
Content-Type: application/json
OrganizationInfoUpdated
Organization info was updated.
Content-Type: application/json
OrganizationInfoDeleted
Organization info was deleted.
Content-Type: application/json
OrganizationMemberUpdated
An organization member was updated.
Content-Type: application/json
OrganizationMembershipCreated
An organization membership was created.
Content-Type: application/json
OrganizationMembershipUpdated
An organization membership was updated.
Content-Type: application/json
CommentCreated
A comment was created.
Content-Type: application/json
CommentUpdated
A comment was updated.
Content-Type: application/json
CommentDeleted
A comment was deleted.
Content-Type: application/json
ExternalCalendarAuthorizationError
An external calendar sync hit an authorization error.
Content-Type: application/json
PatientEducationalResourceUpdated
A patient educational resource was updated.
Content-Type: application/json
PatientEducationalResourceDeleted
A patient educational resource was deleted.
Content-Type: application/json
SentNotificationRecordCreated
A sent notification record was created.
Content-Type: application/json
SentNotificationRecordUpdated
A sent notification record was updated.
Content-Type: application/json
TestCreated
A synthetic test event emitted when validating a webhook endpoint.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.