{"relatedNavbarItem":{"label":"API Docs","link":"/apis/public-api/openapi"},"items":[{"type":"group","label":"API Reference","items":[{"type":"link","label":"Hero Health Public API","link":"/apis/public-api/openapi","routeSlug":"/apis/public-api/openapi"},{"type":"link","label":"Key capabilities","link":"/apis/public-api/openapi/section/key-capabilities","routeSlug":"/apis/public-api/openapi/section/key-capabilities"},{"type":"link","label":"Authentication","link":"/apis/public-api/openapi/section/authentication","routeSlug":"/apis/public-api/openapi/section/authentication"},{"type":"link","label":"Rate limits","link":"/apis/public-api/openapi/section/rate-limits","routeSlug":"/apis/public-api/openapi/section/rate-limits"},{"type":"separator","label":"Appointment Booking"},{"type":"group","label":"Appointments","link":"/apis/public-api/openapi/appointments","routeSlug":"/apis/public-api/openapi/appointments","items":[{"label":"Get an Appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/getappointment","routeSlug":"/apis/public-api/openapi/appointments/getappointment","metadata":{"seo":{"title":"Get an Appointment","description":"Retrieves an appointment by its ID."}},"httpPath":"/v1/appointments/{id}"},{"label":"Get Appointment Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/getappointmentstatus","routeSlug":"/apis/public-api/openapi/appointments/getappointmentstatus","metadata":{"seo":{"title":"Get Appointment Status","description":"Retrieves the status of an appointment by its ID, including the derived booking status and EHR partner status."}},"httpPath":"/v1/appointments/{id}/status"},{"label":"Create an Appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/createappointment","routeSlug":"/apis/public-api/openapi/appointments/createappointment","metadata":{"seo":{"title":"Create an Appointment","description":"Create an appointment reservation for a patient. The appointment is held in a reserved state until confirmed via the Book Appointment endpoint."}},"httpPath":"/v1/appointments"},{"label":"List Appointment Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/listappointmenttypes","routeSlug":"/apis/public-api/openapi/appointments/listappointmenttypes","metadata":{"seo":{"title":"List Appointment Types","description":"Retrieves a list of all appointment types configured for the requesting practice group."}},"httpPath":"/v1/appointment_types"},{"label":"Get Booking Link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/getbookinglink","routeSlug":"/apis/public-api/openapi/appointments/getbookinglink","metadata":{"seo":{"title":"Get Booking Link","description":"Get a booking link and its fields."}},"httpPath":"/v1/booking_links/{id}"},{"label":"Count Bookable Slots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/countslots","routeSlug":"/apis/public-api/openapi/appointments/countslots","metadata":{"seo":{"title":"Count Bookable Slots","description":"Count of all bookable slots for the requesting practice group."}},"httpPath":"/v1/slots/count"},{"label":"Get Bookable Slot","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/getslot","routeSlug":"/apis/public-api/openapi/appointments/getslot","metadata":{"seo":{"title":"Get Bookable Slot","description":"Retrieves a single bookable slot by its ID for the requesting practice group."}},"httpPath":"/v1/slots/{id}"},{"label":"List Bookable Slots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/listslots","routeSlug":"/apis/public-api/openapi/appointments/listslots","metadata":{"seo":{"title":"List Bookable Slots","description":"Retrieve available bookable slots for the practice group. Filter by location, practitioner, appointment type, and date range."}},"httpPath":"/v1/slots"},{"label":"Check slot availability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/checkslotsavailability","routeSlug":"/apis/public-api/openapi/appointments/checkslotsavailability","metadata":{"seo":{"title":"Check slot availability","description":"Check whether a specific slot is still available for booking. Call this immediately before creating an appointment to avoid reservation conflicts."}},"httpPath":"/v1/slots/availability"},{"label":"List Appointments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/listappointments","routeSlug":"/apis/public-api/openapi/appointments/listappointments","metadata":{"seo":{"title":"List Appointments","description":"Retrieves a list of all appointments."}},"httpPath":"/v2/appointments"},{"label":"Book an Appointment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/bookappointmentv2","routeSlug":"/apis/public-api/openapi/appointments/bookappointmentv2","metadata":{"seo":{"title":"Book an Appointment","description":"Submits a previously reserved appointment for booking. Returns immediately withstatus \"pending\"; the booking is confirmed asynchronously. Poll Get AppointmentStatus for the outcome."}},"httpPath":"/v2/appointments/{id}/book"},{"label":"Cancel an Appointment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/cancelappointmentv2","routeSlug":"/apis/public-api/openapi/appointments/cancelappointmentv2","metadata":{"seo":{"title":"Cancel an Appointment","description":"Cancels a confirmed appointment. Returns immediately with status \"cancelling\"; the cancellation is confirmed asynchronously. Poll Get Appointment Status for the outcome."}},"httpPath":"/v2/appointments/{id}/cancel"},{"label":"Reschedule Appointment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/rescheduleappointmentv2","routeSlug":"/apis/public-api/openapi/appointments/rescheduleappointmentv2","metadata":{"seo":{"title":"Reschedule Appointment","description":"Asynchronously reschedules an EHR-confirmed appointment to a new slot (book-new then cancel-old). Returns immediately with a rescheduling status; poll the status endpoint for the outcome."}},"httpPath":"/v2/appointments/{id}/reschedule"},{"label":"Edit an Appointment reservation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/editappointmentv2","routeSlug":"/apis/public-api/openapi/appointments/editappointmentv2","metadata":{"seo":{"title":"Edit an Appointment reservation","description":"Updates an unconfirmed reservation in place - slot, practitioner, reason,patient proxy - and re-stamps the reservation hold, returning the freshreserved_until. Only appointments in the reserved state can be edited;use Reschedule for confirmed appointments. Works for both bookingmechanisms - a reservation has not touched the EHR yet. The locationand appointment type cannot change - release the reservation andre-reserve to move site or change type."}},"httpPath":"/v2/appointments/{id}"},{"label":"List Automated messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/listautomatedmessages","routeSlug":"/apis/public-api/openapi/appointments/listautomatedmessages","metadata":{"seo":{"title":"List Automated messages","description":"Retrieves a list of automated appointment messages."}},"httpPath":"/v2/automated_messages"},{"label":"List Booking links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/listbookinglinks","routeSlug":"/apis/public-api/openapi/appointments/listbookinglinks","metadata":{"seo":{"title":"List Booking links","description":"Retrieves a list of shortlinks filtered by 'booking' link type and version 2."}},"httpPath":"/v2/bookinglinks"},{"label":"Edit an Appointment","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/editappointment","routeSlug":"/apis/public-api/openapi/appointments/editappointment","metadata":{"seo":{"title":"Edit an Appointment","description":"Deprecated: new integrations should use PUT /v2/appointments/{id} (editAppointmentV2) instead. This endpoint remains available for existing hero_confirmed integrations."}},"httpPath":"/v1/appointments/{id}"},{"label":"Book an Appointment","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/bookappointment","routeSlug":"/apis/public-api/openapi/appointments/bookappointment","metadata":{"seo":{"title":"Book an Appointment","description":"Deprecated: new integrations should use PATCH /v2/appointments/{id}/book (bookAppointmentV2) instead. This endpoint remains available for existing hero_confirmed integrations."}},"httpPath":"/v1/appointments/{id}/book"},{"label":"Cancel an Appointment","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/cancelappointment","routeSlug":"/apis/public-api/openapi/appointments/cancelappointment","metadata":{"seo":{"title":"Cancel an Appointment","description":"Deprecated: new integrations should use PATCH /v2/appointments/{id}/cancel (cancelAppointmentV2) instead. This endpoint remains available for existing hero_confirmed integrations."}},"httpPath":"/v1/appointments/{id}/cancel"},{"label":"Reschedule an Appointment","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/appointments/rescheduleappointment","routeSlug":"/apis/public-api/openapi/appointments/rescheduleappointment","metadata":{"seo":{"title":"Reschedule an Appointment","description":"Deprecated: new integrations should use PATCH /v2/appointments/{id}/reschedule (rescheduleAppointmentV2) instead. This endpoint remains available for existing hero_confirmed integrations."}},"httpPath":"/v1/appointments/{id}/reschedule"}]},{"type":"group","label":"Practitioners","link":"/apis/public-api/openapi/practitioners","routeSlug":"/apis/public-api/openapi/practitioners","items":[{"label":"List Practitioners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practitioners/listpractitioners","routeSlug":"/apis/public-api/openapi/practitioners/listpractitioners","metadata":{"seo":{"title":"List Practitioners","description":"Retrieves a list of practitioners configured for online booking on Hero Health."}},"httpPath":"/v1/practitioners"},{"label":"Get a Practitioner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practitioners/getpractitioner","routeSlug":"/apis/public-api/openapi/practitioners/getpractitioner","metadata":{"seo":{"title":"Get a Practitioner","description":"Retrieves a single practitioner by ID."}},"httpPath":"/v1/practitioners/{id}"},{"label":"Update a Practitioner","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practitioners/updatepractitioner","routeSlug":"/apis/public-api/openapi/practitioners/updatepractitioner","metadata":{"seo":{"title":"Update a Practitioner","description":"Updates a practitioner's identity, contact and notification fields."}},"httpPath":"/v1/practitioners/{id}"},{"label":"Archive a Practitioner","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practitioners/archivepractitioner","routeSlug":"/apis/public-api/openapi/practitioners/archivepractitioner","metadata":{"seo":{"title":"Archive a Practitioner","description":"Archives a practitioner so they are no longer active."}},"httpPath":"/v1/practitioners/{id}"}]},{"type":"group","label":"Locations","link":"/apis/public-api/openapi/locations","routeSlug":"/apis/public-api/openapi/locations","items":[{"label":"List Locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/locations/listlocations","routeSlug":"/apis/public-api/openapi/locations/listlocations","metadata":{"seo":{"title":"List Locations","description":"Retrieves a list of the locations configured for a practice group on Hero Health."}},"httpPath":"/v1/locations"},{"label":"Get a Location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/locations/getlocationbyid","routeSlug":"/apis/public-api/openapi/locations/getlocationbyid","metadata":{"seo":{"title":"Get a Location","description":"Retrieve a single location by its ID."}},"httpPath":"/v1/locations/{id}"},{"label":"Update a Location","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/locations/updatelocation","routeSlug":"/apis/public-api/openapi/locations/updatelocation","metadata":{"seo":{"title":"Update a Location","description":"Update an existing location."}},"httpPath":"/v1/locations/{id}"},{"label":"Archive a Location","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/locations/archivelocation","routeSlug":"/apis/public-api/openapi/locations/archivelocation","metadata":{"seo":{"title":"Archive a Location","description":"Archive a location. Archived locations are no longer visible to patients."}},"httpPath":"/v1/locations/{id}"}]},{"type":"separator","label":"Administration"},{"type":"group","label":"Admin","link":"/apis/public-api/openapi/admin","routeSlug":"/apis/public-api/openapi/admin","items":[{"label":"List Admins","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/listadmins","routeSlug":"/apis/public-api/openapi/admin/listadmins","metadata":{"seo":{"title":"List Admins","description":"Retrieves a list of all admins."}},"httpPath":"/v1/admins"},{"label":"Update an Admin","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/updateadmin","routeSlug":"/apis/public-api/openapi/admin/updateadmin","metadata":{"seo":{"title":"Update an Admin","description":"Updates an admin using the provided parameters."}},"httpPath":"/v1/admins/{id}"},{"label":"Upsert Admin In-Context Signature","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/upsertadminsignature","routeSlug":"/apis/public-api/openapi/admin/upsertadminsignature","metadata":{"seo":{"title":"Upsert Admin In-Context Signature","description":"Insert or update a signature for Admin in context."}},"httpPath":"/v1/admin/signature"},{"label":"Upsert Admin In-Context Preferences","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/upsertadminpreferences","routeSlug":"/apis/public-api/openapi/admin/upsertadminpreferences","metadata":{"seo":{"title":"Upsert Admin In-Context Preferences","description":"Insert or update preferences for the given Admin."}},"httpPath":"/v1/admin/preferences"},{"label":"Get prescriber details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/getprescriber","routeSlug":"/apis/public-api/openapi/admin/getprescriber","metadata":{"seo":{"title":"Get prescriber details","description":"Retrieves prescriber details for the admin."}},"httpPath":"/v1/admins/{id}/prescriber"},{"label":"List Admin Teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/listadminteams","routeSlug":"/apis/public-api/openapi/admin/listadminteams","metadata":{"seo":{"title":"List Admin Teams","description":"Retrieves a list of all admin teams."}},"httpPath":"/v1/admin_teams"},{"label":"Create an Admin Team","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/admin/createadminteam","routeSlug":"/apis/public-api/openapi/admin/createadminteam","metadata":{"seo":{"title":"Create an Admin Team","description":"Creates a new admin team with the specified name and admin members."}},"httpPath":"/v1/admin_teams"}]},{"type":"group","label":"Practice Group","link":"/apis/public-api/openapi/practice-group","routeSlug":"/apis/public-api/openapi/practice-group","items":[{"label":"Create an Access Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/createaccesstoken","routeSlug":"/apis/public-api/openapi/practice-group/createaccesstoken","metadata":{"seo":{"title":"Create an Access Token","description":"Generate a short-lived Access Token (JWT) to authenticate Hero Health Elements (SDKs)."}},"httpPath":"/v1/access_token"},{"label":"List Content Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/listcontenttemplates","routeSlug":"/apis/public-api/openapi/practice-group/listcontenttemplates","metadata":{"seo":{"title":"List Content Templates","description":"Retrieves a list of content templates available to the requesting practice group."}},"httpPath":"/v1/content-templates"},{"label":"Get Practice Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/getpracticegroupbyid","routeSlug":"/apis/public-api/openapi/practice-group/getpracticegroupbyid","metadata":{"seo":{"title":"Get Practice Group","description":"Retrieves information regarding the authenticated Practice Group."}},"httpPath":"/v1/me"},{"label":"Get Practice Group Capabilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/getcapabilities","routeSlug":"/apis/public-api/openapi/practice-group/getcapabilities","metadata":{"seo":{"title":"Get Practice Group Capabilities","description":"Retrieves capabilities of the authenticated Practice Group."}},"httpPath":"/v1/me/capabilities"},{"label":"List Network Practices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/listnetworkpractices","routeSlug":"/apis/public-api/openapi/practice-group/listnetworkpractices","metadata":{"seo":{"title":"List Network Practices","description":"List practice groups from the same network as the authenticated Practice Group."}},"httpPath":"/v1/network"},{"label":"Get Practice Group SMS credit count","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/practice-group/getsmscreditcount","routeSlug":"/apis/public-api/openapi/practice-group/getsmscreditcount","metadata":{"seo":{"title":"Get Practice Group SMS credit count","description":"Retrieves the authenticated Practice Group's SMS credit count."}},"httpPath":"/v1/me/sms-credits"}]},{"type":"group","label":"Patients","link":"/apis/public-api/openapi/patients","routeSlug":"/apis/public-api/openapi/patients","items":[{"label":"Sync Hero patient with EHR","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/connectpatientehr","routeSlug":"/apis/public-api/openapi/patients/connectpatientehr","metadata":{"seo":{"title":"Sync Hero patient with EHR","description":"Sync a Hero patient with an EHR patient"}},"httpPath":"/v1/patients/{id}/ehr/connect"},{"label":"Preview Patient Merging","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/previewpatientmerge","routeSlug":"/apis/public-api/openapi/patients/previewpatientmerge","metadata":{"seo":{"title":"Preview Patient Merging","description":"Return a preview of a merge between two patients hand provide a merge token"}},"httpPath":"/v1/patients/{id}/merge/preview"},{"label":"Merge Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/mergepatient","routeSlug":"/apis/public-api/openapi/patients/mergepatient","metadata":{"seo":{"title":"Merge Patients","description":"Merge one patient with another"}},"httpPath":"/v1/patients/{id}/merge"},{"label":"Get a Patient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/getpatientbyid","routeSlug":"/apis/public-api/openapi/patients/getpatientbyid","metadata":{"seo":{"title":"Get a Patient","description":"Retrieve patient information."}},"httpPath":"/v1/patients/{id}"},{"label":"List Patients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/listpatients","routeSlug":"/apis/public-api/openapi/patients/listpatients","metadata":{"seo":{"title":"List Patients","description":"Retrieve a list of patients for the practice group. Filter by EMIS ID, NHS number, or date of birth using the field and search query parameters."}},"httpPath":"/v1/patients"},{"label":"Register a Patient using PDS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/registerpatientpds","routeSlug":"/apis/public-api/openapi/patients/registerpatientpds","metadata":{"seo":{"title":"Register a Patient using PDS","description":"Register a patient by tracing them against the NHS Spine via PDS (Personal Demographics Service). Provide an NHS number and date of birth, or alternatively a combination of forename, surname, DOB, and postcode."}},"httpPath":"/v1/patients/register_pds"},{"label":"Register a Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/registerpatient","routeSlug":"/apis/public-api/openapi/patients/registerpatient","metadata":{"seo":{"title":"Register a Patient","description":"Create or update a patient based on the data sent. If a patient with matching NHS number and DOB exists for the practice group, it will be updated. Otherwise, a new patient record is created."}},"httpPath":"/v1/patients/register"},{"label":"Get Patient Billing Info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/patientbillinginfo","routeSlug":"/apis/public-api/openapi/patients/patientbillinginfo","metadata":{"seo":{"title":"Get Patient Billing Info","description":"Retrieves billing information for the patient."}},"httpPath":"/v1/patients/{id}/billing_info"},{"label":"List Patient Payment Methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/listpatientpaymentmethods","routeSlug":"/apis/public-api/openapi/patients/listpatientpaymentmethods","metadata":{"seo":{"title":"List Patient Payment Methods","description":"Retrieves payment methods for default stripe customer of patient."}},"httpPath":"/v1/patients/{id}/payment_methods"},{"label":"Get a Patient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/getpatientbyidv2","routeSlug":"/apis/public-api/openapi/patients/getpatientbyidv2","metadata":{"seo":{"title":"Get a Patient","description":"Retrieve patient information."}},"httpPath":"/v2/patients/{id}"},{"label":"List Patients (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/listpatientsv2","routeSlug":"/apis/public-api/openapi/patients/listpatientsv2","metadata":{"seo":{"title":"List Patients (v2)","description":"Retrieves a list of all patients, from either the EHR or HERO. The verified_email and verified_phone fields search against verified portal credentials (Hero DB only)."}},"httpPath":"/v2/patients"},{"label":"List Patients (v3)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/patients/listpatientsv3","routeSlug":"/apis/public-api/openapi/patients/listpatientsv3","metadata":{"seo":{"title":"List Patients (v3)","description":"Retrieve a list of patients for the practice group using explicit patient filters."}},"httpPath":"/v3/patients"}]},{"type":"separator","label":"Triage"},{"type":"group","label":"Episode","link":"/apis/public-api/openapi/episode","routeSlug":"/apis/public-api/openapi/episode","items":[{"label":"Count Episodes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/countepisodes","routeSlug":"/apis/public-api/openapi/episode/countepisodes","metadata":{"seo":{"title":"Count Episodes","description":"Retrieves a count of all episodes for a practice group."}},"httpPath":"/v1/episodes/count"},{"label":"List Episodes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/listepisodes","routeSlug":"/apis/public-api/openapi/episode/listepisodes","metadata":{"seo":{"title":"List Episodes","description":"Retrieves a list of all episodes for a practice group."}},"httpPath":"/v1/episodes"},{"label":"Get Episode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/getepisode","routeSlug":"/apis/public-api/openapi/episode/getepisode","metadata":{"seo":{"title":"Get Episode","description":"Retrieve episode information for the given ID."}},"httpPath":"/v1/episodes/{id}"},{"label":"Update an episode","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/updateepisode","routeSlug":"/apis/public-api/openapi/episode/updateepisode","metadata":{"seo":{"title":"Update an episode","description":"Updates an episode using the provided parameters."}},"httpPath":"/v1/episodes/{id}"},{"label":"Create a note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/createepisodenote","routeSlug":"/apis/public-api/openapi/episode/createepisodenote","metadata":{"seo":{"title":"Create a note","description":"Create a note for an episode in inbox."}},"httpPath":"/v1/notes"},{"label":"Count Episodes (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/countepisodesv2","routeSlug":"/apis/public-api/openapi/episode/countepisodesv2","metadata":{"seo":{"title":"Count Episodes (v2)","description":"Counts the episodes for a practice group, with the same filters as the list, without loading any of them."}},"httpPath":"/v2/episodes/count"},{"label":"List Episodes (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/listepisodesv2","routeSlug":"/apis/public-api/openapi/episode/listepisodesv2","metadata":{"seo":{"title":"List Episodes (v2)","description":"Retrieves a list of all episodes for a practice group."}},"httpPath":"/v2/episodes"},{"label":"Get Episode (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/episode/getepisodev2","routeSlug":"/apis/public-api/openapi/episode/getepisodev2","metadata":{"seo":{"title":"Get Episode (v2)","description":"Retrieves the episode payload using the multi-task view for the given ID."}},"httpPath":"/v2/episodes/{id}"}]},{"type":"group","label":"Care Navigation","link":"/apis/public-api/openapi/care-navigation","routeSlug":"/apis/public-api/openapi/care-navigation","items":[{"label":"List Pathways","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/listpathways","routeSlug":"/apis/public-api/openapi/care-navigation/listpathways","metadata":{"seo":{"title":"List Pathways","description":"Retrieves a list of pathways for the requesting practice group."}},"httpPath":"/v1/care-nav/pathways"},{"label":"Create Pathway","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/createpathway","routeSlug":"/apis/public-api/openapi/care-navigation/createpathway","metadata":{"seo":{"title":"Create Pathway","description":"Creates a pathway and its initial submission types for the requesting practice group."}},"httpPath":"/v1/care-nav/pathways"},{"label":"Get Pathway","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/getpathway","routeSlug":"/apis/public-api/openapi/care-navigation/getpathway","metadata":{"seo":{"title":"Get Pathway","description":"Retrieves a pathway."}},"httpPath":"/v1/care-nav/pathways/{id}"},{"label":"Update Pathway","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/updatepathway","routeSlug":"/apis/public-api/openapi/care-navigation/updatepathway","metadata":{"seo":{"title":"Update Pathway","description":"Updates a pathway for the requesting practice group."}},"httpPath":"/v1/care-nav/pathways/{id}"},{"label":"Delete Pathway","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/deletepathway","routeSlug":"/apis/public-api/openapi/care-navigation/deletepathway","metadata":{"seo":{"title":"Delete Pathway","description":"Soft deletes a pathway for the requesting practice group."}},"httpPath":"/v1/care-nav/pathways/{id}"},{"label":"Get Care Navigation Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/getcarenavigationsettings","routeSlug":"/apis/public-api/openapi/care-navigation/getcarenavigationsettings","metadata":{"seo":{"title":"Get Care Navigation Settings","description":"Retrieves the care navigation settings for the requesting practice group."}},"httpPath":"/v1/care-nav/settings"},{"label":"Update Care Navigation Settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/updatecarenavigationsettings","routeSlug":"/apis/public-api/openapi/care-navigation/updatecarenavigationsettings","metadata":{"seo":{"title":"Update Care Navigation Settings","description":"Updates the care navigation settings for the requesting practice group."}},"httpPath":"/v1/care-nav/settings"},{"label":"List Care Navigation Opening Hours","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/listcarenavigationopeninghours","routeSlug":"/apis/public-api/openapi/care-navigation/listcarenavigationopeninghours","metadata":{"seo":{"title":"List Care Navigation Opening Hours","description":"Lists care navigation opening hours for the requesting practice group."}},"httpPath":"/v1/care-nav/opening-hours"},{"label":"Create Care Navigation Opening Hour","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/createcarenavigationopeninghour","routeSlug":"/apis/public-api/openapi/care-navigation/createcarenavigationopeninghour","metadata":{"seo":{"title":"Create Care Navigation Opening Hour","description":"Creates a care navigation opening hour for the requesting practice group."}},"httpPath":"/v1/care-nav/opening-hours"},{"label":"Update Care Navigation Opening Hour","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/updatecarenavigationopeninghour","routeSlug":"/apis/public-api/openapi/care-navigation/updatecarenavigationopeninghour","metadata":{"seo":{"title":"Update Care Navigation Opening Hour","description":"Updates a single care navigation opening hour for the requesting practice group."}},"httpPath":"/v1/care-nav/opening-hours/{id}"},{"label":"Delete Care Navigation Opening Hour","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/deletecarenavigationopeninghour","routeSlug":"/apis/public-api/openapi/care-navigation/deletecarenavigationopeninghour","metadata":{"seo":{"title":"Delete Care Navigation Opening Hour","description":"Deletes a single care navigation opening hour for the requesting practice group."}},"httpPath":"/v1/care-nav/opening-hours/{id}"},{"label":"Get Care Navigation Submission","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/getcarenavsubmission","routeSlug":"/apis/public-api/openapi/care-navigation/getcarenavsubmission","metadata":{"seo":{"title":"Get Care Navigation Submission","description":"Get a care navigation submission and its fields. An acting admin without the required policies still receives the submission, with the attachment link and file name removed from any attachment answer."}},"httpPath":"/v1/care-nav/submissions/{id}"},{"label":"List Care Navigation Submissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/listcarenavsubmissions","routeSlug":"/apis/public-api/openapi/care-navigation/listcarenavsubmissions","metadata":{"seo":{"title":"List Care Navigation Submissions","description":"Retrieves a list of all care navigation submissions."}},"httpPath":"/v1/care-nav/submissions"},{"label":"Create Care Nav Submission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/createsubmission","routeSlug":"/apis/public-api/openapi/care-navigation/createsubmission","metadata":{"seo":{"title":"Create Care Nav Submission","description":"Create a Care Nav Submission."}},"httpPath":"/v1/care-nav/submission"},{"label":"List Submission Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/listsubmissiontype","routeSlug":"/apis/public-api/openapi/care-navigation/listsubmissiontype","metadata":{"seo":{"title":"List Submission Types","description":"Retrieves a list of submission types for the requesting practice group."}},"httpPath":"/v1/care-nav/submission-types"},{"label":"Create Submission Type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/createsubmissiontype","routeSlug":"/apis/public-api/openapi/care-navigation/createsubmissiontype","metadata":{"seo":{"title":"Create Submission Type","description":"Creates a submission type for an existing pathway in the requesting practice group."}},"httpPath":"/v1/care-nav/submission-types"},{"label":"Get Submission Type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/getsubmissiontype","routeSlug":"/apis/public-api/openapi/care-navigation/getsubmissiontype","metadata":{"seo":{"title":"Get Submission Type","description":"Retrieves a submission type."}},"httpPath":"/v1/care-nav/submission-types/{id}"},{"label":"Update Submission Type","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/updatesubmissiontype","routeSlug":"/apis/public-api/openapi/care-navigation/updatesubmissiontype","metadata":{"seo":{"title":"Update Submission Type","description":"Updates a submission type for the requesting practice group."}},"httpPath":"/v1/care-nav/submission-types/{id}"},{"label":"Archive Submission Type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/care-navigation/archivesubmissiontype","routeSlug":"/apis/public-api/openapi/care-navigation/archivesubmissiontype","metadata":{"seo":{"title":"Archive Submission Type","description":"Archives a submission type for the requesting practice group."}},"httpPath":"/v1/care-nav/submission-types/{id}"}]},{"type":"group","label":"WriteToRecord","link":"/apis/public-api/openapi/writetorecord","routeSlug":"/apis/public-api/openapi/writetorecord","items":[{"label":"Get Write to Record status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/writetorecord/getwritetorecordstatus","routeSlug":"/apis/public-api/openapi/writetorecord/getwritetorecordstatus","metadata":{"seo":{"title":"Get Write to Record status","description":"Get the latest Write to Record status for a resource."}},"httpPath":"/v1/write-to-record/status"}]},{"type":"group","label":"Task","link":"/apis/public-api/openapi/task","routeSlug":"/apis/public-api/openapi/task","items":[{"label":"Update a task","deprecated":true,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/task/updatetask","routeSlug":"/apis/public-api/openapi/task/updatetask","metadata":{"seo":{"title":"Update a task","description":"Updates a task using the provided parameters."}},"httpPath":"/v1/tasks/{id}"},{"label":"Get Task","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/task/gettask","routeSlug":"/apis/public-api/openapi/task/gettask","metadata":{"seo":{"title":"Get Task","description":"Retrieve task information for the given ID."}},"httpPath":"/v2/tasks/{id}"},{"label":"List Tasks","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/task/listtasks","routeSlug":"/apis/public-api/openapi/task/listtasks","metadata":{"seo":{"title":"List Tasks","description":"Retrieves a list of all tasks for a practice group."}},"httpPath":"/v2/tasks"}]},{"type":"separator","label":"Messaging"},{"type":"group","label":"Individual messages","link":"/apis/public-api/openapi/individual-messages","routeSlug":"/apis/public-api/openapi/individual-messages","items":[{"label":"Get Message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/getmessage","routeSlug":"/apis/public-api/openapi/individual-messages/getmessage","metadata":{"seo":{"title":"Get Message","description":"Retrieves a message by its ID. An acting admin without the required policy still receives the message, with the link removed from every attachment."}},"httpPath":"/v1/messages/{id}"},{"label":"Send a Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/sendmessage","routeSlug":"/apis/public-api/openapi/individual-messages/sendmessage","metadata":{"seo":{"title":"Send a Message","description":"Send a message to a patient via SMS, email, NHS App, or as a Hero-only audit record."}},"httpPath":"/v1/messages/send"},{"label":"Get Message Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/getstatus","routeSlug":"/apis/public-api/openapi/individual-messages/getstatus","metadata":{"seo":{"title":"Get Message Status","description":"Retrieve message write to record and send status"}},"httpPath":"/v1/messages/{id}/status"},{"label":"List Assignee Collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/assigneecollections","routeSlug":"/apis/public-api/openapi/individual-messages/assigneecollections","metadata":{"seo":{"title":"List Assignee Collection","description":"Retrieve a list of all assignees including Admin or AdminTeam for the requesting practice group and admin"}},"httpPath":"/v1/messages/assignee/collection"},{"label":"Search SNOMED concepts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/searchsnomed","routeSlug":"/apis/public-api/openapi/individual-messages/searchsnomed","metadata":{"seo":{"title":"Search SNOMED concepts","description":"Searches by code when query is numeric (a single code or a comma-separated list of codes), otherwise searches by free-text term."}},"httpPath":"/v1/snomed"},{"label":"List Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/listtemplates","routeSlug":"/apis/public-api/openapi/individual-messages/listtemplates","metadata":{"seo":{"title":"List Templates","description":"Retrieves a list of message templates for the requesting practice group."}},"httpPath":"/v1/templates"},{"label":"Get Automated Message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/getautomatedmessage","routeSlug":"/apis/public-api/openapi/individual-messages/getautomatedmessage","metadata":{"seo":{"title":"Get Automated Message","description":"Retrieve automated message for the given ID."}},"httpPath":"/v2/automated_messages/{id}"},{"label":"List Sent Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/listsentmessages","routeSlug":"/apis/public-api/openapi/individual-messages/listsentmessages","metadata":{"seo":{"title":"List Sent Messages","description":"Retrieves a list of all sent messages."}},"httpPath":"/v2/sent_messages"},{"label":"Validate a SNOMED Code","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/individual-messages/validatesnomed","routeSlug":"/apis/public-api/openapi/individual-messages/validatesnomed","metadata":{"seo":{"title":"Validate a SNOMED Code","description":"Deprecated. Use GET /v1/snomed with the code as the query parameter to validate a SNOMED code instead — a non-empty result confirms the code is valid."}},"httpPath":"/v1/snomed/validate"}]},{"type":"group","label":"Batch messages","link":"/apis/public-api/openapi/batch-messages","routeSlug":"/apis/public-api/openapi/batch-messages","items":[{"label":"Create a Batch Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/createbatchmessage","routeSlug":"/apis/public-api/openapi/batch-messages/createbatchmessage","metadata":{"seo":{"title":"Create a Batch Message","description":"Create a Batch Message"}},"httpPath":"/v1/batch_message"},{"label":"List Batch Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/listbatchmessages","routeSlug":"/apis/public-api/openapi/batch-messages/listbatchmessages","metadata":{"seo":{"title":"List Batch Messages","description":"List Batch Messages"}},"httpPath":"/v1/batch_message"},{"label":"Send a Batch Message","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/sendbatchmessage","routeSlug":"/apis/public-api/openapi/batch-messages/sendbatchmessage","metadata":{"seo":{"title":"Send a Batch Message","description":"Send a Batch Message"}},"httpPath":"/v1/batch_message/{id}/send"},{"label":"Get a Batch Message","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/getbatchmessage","routeSlug":"/apis/public-api/openapi/batch-messages/getbatchmessage","metadata":{"seo":{"title":"Get a Batch Message","description":"Get a Batch Message"}},"httpPath":"/v1/batch_message/{id}"},{"label":"List Batch Message Recipients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/listrecipients","routeSlug":"/apis/public-api/openapi/batch-messages/listrecipients","metadata":{"seo":{"title":"List Batch Message Recipients","description":"List Batch Message Recipients"}},"httpPath":"/v1/batch_message/{id}/recipients"},{"label":"List Batch Message Sends","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/batch-messages/listbatchmessagesends","routeSlug":"/apis/public-api/openapi/batch-messages/listbatchmessagesends","metadata":{"seo":{"title":"List Batch Message Sends","description":"List Batch Message Sends"}},"httpPath":"/v1/batch_message/{id}/messages"}]},{"type":"group","label":"Links","link":"/apis/public-api/openapi/links","routeSlug":"/apis/public-api/openapi/links","items":[{"label":"Create an Attachment Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/createattachmentlink","routeSlug":"/apis/public-api/openapi/links/createattachmentlink","metadata":{"seo":{"title":"Create an Attachment Link","description":"Creates a attachment link using the provided parameters."}},"httpPath":"/v1/attachment_links"},{"label":"Create a Booking Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/createbookinglink","routeSlug":"/apis/public-api/openapi/links/createbookinglink","metadata":{"seo":{"title":"Create a Booking Link","description":"Create a booking link that can be shared with a patient. The link allows the patient to self-book into an available appointment slot."}},"httpPath":"/v1/booking_links"},{"label":"Update a Booking Link","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/updatebookinglink","routeSlug":"/apis/public-api/openapi/links/updatebookinglink","metadata":{"seo":{"title":"Update a Booking Link","description":"Updates a booking link using the provided parameters."}},"httpPath":"/v1/booking_links/{id}"},{"label":"Create a Form Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/createformlink","routeSlug":"/apis/public-api/openapi/links/createformlink","metadata":{"seo":{"title":"Create a Form Link","description":"Creates a form link using the provided parameters."}},"httpPath":"/v1/form_links"},{"label":"Get Link Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/getlinkstatus","routeSlug":"/apis/public-api/openapi/links/getlinkstatus","metadata":{"seo":{"title":"Get Link Status","description":"Get the status of a given link."}},"httpPath":"/v1/links/status"},{"label":"List Short links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/listshortlinks","routeSlug":"/apis/public-api/openapi/links/listshortlinks","metadata":{"seo":{"title":"List Short links","description":"Retrieves a list of shortlinks filtered by given parameters."}},"httpPath":"/v1/short_links"},{"label":"Create a Video Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/links/createvideolink","routeSlug":"/apis/public-api/openapi/links/createvideolink","metadata":{"seo":{"title":"Create a Video Link","description":"Creates a video link using the provided parameters."}},"httpPath":"/v1/video_links"}]},{"type":"separator","label":"Webhooks"},{"type":"group","label":"Webhooks","link":"/apis/public-api/openapi/webhooks","routeSlug":"/apis/public-api/openapi/webhooks","items":[{"label":"Create a Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/webhooks/createwebhook","routeSlug":"/apis/public-api/openapi/webhooks/createwebhook","metadata":{"seo":{"title":"Create a Webhook","description":"Create a webhook subscription for the authenticated practice group. Hero will send an HTTP POST request to the specified URL whenever the subscribed event occurs."}},"httpPath":"/v1/webhooks"},{"label":"List Webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/webhooks/listwebhooks","routeSlug":"/apis/public-api/openapi/webhooks/listwebhooks","metadata":{"seo":{"title":"List Webhooks","description":"Retrieve all webhook subscriptions for the authenticated practice group. Use this to audit active subscriptions or check event types you are subscribed to."}},"httpPath":"/v1/webhooks"},{"label":"Delete a Webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/webhooks/deletewebhook","routeSlug":"/apis/public-api/openapi/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete a Webhook","description":"Delete a webhook subscription. Hero will immediately stop sending events to the webhook URL. This action cannot be undone — you will need to create a new webhook to resubscribe."}},"httpPath":"/v1/webhooks/{id}"},{"label":"List Webhook Executions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/webhooks/listwebhookexecutions","routeSlug":"/apis/public-api/openapi/webhooks/listwebhookexecutions","metadata":{"seo":{"title":"List Webhook Executions","description":"Retrieves a list of executions for a specific webhook."}},"httpPath":"/v1/webhooks/{id}/executions"}]},{"type":"separator","label":"Payments & Billing"},{"type":"group","label":"Invoicing","link":"/apis/public-api/openapi/invoicing","routeSlug":"/apis/public-api/openapi/invoicing","items":[{"label":"List Coupons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/invoicing/listcoupons","routeSlug":"/apis/public-api/openapi/invoicing/listcoupons","metadata":{"seo":{"title":"List Coupons","description":"Retrieves a list of Stripe coupons for the requesting practice group."}},"httpPath":"/v1/invoicing/coupons"},{"label":"Create Invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/invoicing/createinvoice","routeSlug":"/apis/public-api/openapi/invoicing/createinvoice","metadata":{"seo":{"title":"Create Invoice","description":"Creates a new invoice for a patient."}},"httpPath":"/v1/invoicing/invoices"},{"label":"Update Invoice","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/invoicing/updateinvoice","routeSlug":"/apis/public-api/openapi/invoicing/updateinvoice","metadata":{"seo":{"title":"Update Invoice","description":"Updates an existing invoice."}},"httpPath":"/v1/invoicing/invoices/{id}"},{"label":"Link Invoice to Appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/invoicing/linkinvoice","routeSlug":"/apis/public-api/openapi/invoicing/linkinvoice","metadata":{"seo":{"title":"Link Invoice to Appointment","description":"Links an external Stripe invoice to an appointment."}},"httpPath":"/v1/invoicing/invoices/link"},{"label":"List Products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/invoicing/listproducts","routeSlug":"/apis/public-api/openapi/invoicing/listproducts","metadata":{"seo":{"title":"List Products","description":"Retrieves a list of Stripe products for the requesting practice group."}},"httpPath":"/v1/invoicing/products"}]},{"type":"group","label":"Memberships","link":"/apis/public-api/openapi/memberships","routeSlug":"/apis/public-api/openapi/memberships","items":[{"label":"Create Membership Policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/memberships/createmembershippolicy","routeSlug":"/apis/public-api/openapi/memberships/createmembershippolicy","metadata":{"seo":{"title":"Create Membership Policy","description":"Creates a new membership policy for the requesting practice group."}},"httpPath":"/v1/invoicing/membership-policies"},{"label":"List Membership Schemes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/memberships/listmembershipschemes","routeSlug":"/apis/public-api/openapi/memberships/listmembershipschemes","metadata":{"seo":{"title":"List Membership Schemes","description":"Retrieves a list of membership schemes for the requesting practice group."}},"httpPath":"/v1/invoicing/membership-schemes"},{"label":"List Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/memberships/listsubscriptions","routeSlug":"/apis/public-api/openapi/memberships/listsubscriptions","metadata":{"seo":{"title":"List Subscriptions","description":"Retrieves a list of subscriptions for a practice group."}},"httpPath":"/v1/subscriptions"},{"label":"List Subscribers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/memberships/listsubscribers","routeSlug":"/apis/public-api/openapi/memberships/listsubscribers","metadata":{"seo":{"title":"List Subscribers","description":"Retrieves a list of subscribers for a practice group."}},"httpPath":"/v1/subscribers"}]},{"type":"group","label":"Prescriptions","link":"/apis/public-api/openapi/prescriptions","routeSlug":"/apis/public-api/openapi/prescriptions","items":[{"label":"Get Prescriber's Pharmacies List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/listprescriberpharmacies","routeSlug":"/apis/public-api/openapi/prescriptions/listprescriberpharmacies","metadata":{"seo":{"title":"Get Prescriber's Pharmacies List","description":"Retrieve a list of pharmacies for the prescriber."}},"httpPath":"/v1/prescriber/{id}/pharmacies"},{"label":"Create Pharmacy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/createpharmacy","routeSlug":"/apis/public-api/openapi/prescriptions/createpharmacy","metadata":{"seo":{"title":"Create Pharmacy","description":"Create a new Pharmacy for the prescriber."}},"httpPath":"/v1/pharmacies"},{"label":"Create a Prescription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/createprescription","routeSlug":"/apis/public-api/openapi/prescriptions/createprescription","metadata":{"seo":{"title":"Create a Prescription","description":"Create a new prescription for a patient."}},"httpPath":"/v1/prescriptions"},{"label":"Get a Prescription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/getprescriptionbyid","routeSlug":"/apis/public-api/openapi/prescriptions/getprescriptionbyid","metadata":{"seo":{"title":"Get a Prescription","description":"Retrieve details of a specific prescription by its ID."}},"httpPath":"/v1/prescriptions/{id}"},{"label":"List Prescriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/listprescriptions","routeSlug":"/apis/public-api/openapi/prescriptions/listprescriptions","metadata":{"seo":{"title":"List Prescriptions","description":"Retrieves a list of all prescriptions for a patient."}},"httpPath":"/v2/prescriptions"},{"label":"Create Prescription with Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/createprescriptionwithpatient","routeSlug":"/apis/public-api/openapi/prescriptions/createprescriptionwithpatient","metadata":{"seo":{"title":"Create Prescription with Patient","description":"Creates a new prescription and associates it with a patient."}},"httpPath":"/v2/prescriptions"},{"label":"Get Prescriber","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/prescriptions/getprescriber","routeSlug":"/apis/public-api/openapi/prescriptions/getprescriber","metadata":{"seo":{"title":"Get Prescriber","description":"Retrieves a prescriber by its ID."}},"httpPath":"/v1/prescriber/{id}"}]},{"type":"group","label":"Customers","link":"/apis/public-api/openapi/customers","routeSlug":"/apis/public-api/openapi/customers","items":[{"label":"List Customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/customers/listcustomers","routeSlug":"/apis/public-api/openapi/customers/listcustomers","metadata":{"seo":{"title":"List Customers","description":"Retrieves a list of Stripe customers for the requesting practice group."}},"httpPath":"/v1/invoicing/customers"},{"label":"Create Customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/customers/createcustomer","routeSlug":"/apis/public-api/openapi/customers/createcustomer","metadata":{"seo":{"title":"Create Customer","description":"Creates a new Stripe customer for the requesting practice group."}},"httpPath":"/v1/invoicing/customers"},{"label":"Get Default Customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/customers/getdefaultcustomer","routeSlug":"/apis/public-api/openapi/customers/getdefaultcustomer","metadata":{"seo":{"title":"Get Default Customer","description":"Retrieves the default Stripe customer for a patient."}},"httpPath":"/v1/invoicing/customers/default"}]},{"type":"separator","label":"Forms & Templates"},{"type":"group","label":"Form","link":"/apis/public-api/openapi/form","routeSlug":"/apis/public-api/openapi/form","items":[{"label":"List Forms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/listforms","routeSlug":"/apis/public-api/openapi/form/listforms","metadata":{"seo":{"title":"List Forms","description":"Retrieves a list of all forms configured for the requesting practice group."}},"httpPath":"/v1/forms"},{"label":"Create Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/createform","routeSlug":"/apis/public-api/openapi/form/createform","metadata":{"seo":{"title":"Create Form","description":"Create a new form template with fields."}},"httpPath":"/v1/forms"},{"label":"Update Form","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/updateform","routeSlug":"/apis/public-api/openapi/form/updateform","metadata":{"seo":{"title":"Update Form","description":"Update an existing form template, replacing all fields."}},"httpPath":"/v1/forms/{id}"},{"label":"Get Form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/getform","routeSlug":"/apis/public-api/openapi/form/getform","metadata":{"seo":{"title":"Get Form","description":"Get a form and its fields."}},"httpPath":"/v1/forms/{id}"},{"label":"Create Form Response","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/createresponse","routeSlug":"/apis/public-api/openapi/form/createresponse","metadata":{"seo":{"title":"Create Form Response","description":"Create a response for a given Form ID."}},"httpPath":"/v1/forms/{id}/response"},{"label":"Update Form Response","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form/updateformresponse","routeSlug":"/apis/public-api/openapi/form/updateformresponse","metadata":{"seo":{"title":"Update Form Response","description":"Update form response for a given form response ID."}},"httpPath":"/v1/forms/response/{id}"}]},{"type":"group","label":"Form Response","link":"/apis/public-api/openapi/form-response","routeSlug":"/apis/public-api/openapi/form-response","items":[{"label":"Get FormResponse","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form-response/getformresponse","routeSlug":"/apis/public-api/openapi/form-response/getformresponse","metadata":{"seo":{"title":"Get FormResponse","description":"Get a form response and its fields."}},"httpPath":"/v1/form_response/{id}"},{"label":"Get FormSubmissionResponse","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form-response/getformsubmissionresponsedata","routeSlug":"/apis/public-api/openapi/form-response/getformsubmissionresponsedata","metadata":{"seo":{"title":"Get FormSubmissionResponse","description":"Get a form submission response and its fields. An acting admin without the required policies still receives the response, with the attachment link and file name removed from any attachment answer."}},"httpPath":"/v1/form_submission_response/{id}"},{"label":"List Form Responses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/public-api/openapi/form-response/listformresponses","routeSlug":"/apis/public-api/openapi/form-response/listformresponses","metadata":{"seo":{"title":"List Form Responses","description":"Retrieves a list of all form responses."}},"httpPath":"/v2/form_responses"}]}],"icon":"solid code"},{"type":"group","label":"Webhook Events","items":[{"type":"link","label":"HeroHealth Webhooks","link":"/apis/webhooks/asyncapi","routeSlug":"/apis/webhooks/asyncapi"},{"label":"appointment.confirmed","type":"group","link":"/apis/webhooks/asyncapi/channels/appointment.confirmed","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.confirmed","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"appointment.confirmed"}},"items":[{"label":"An appointment has been confirmed","type":"link","link":"/apis/webhooks/asyncapi/channels/appointment.confirmed/operations/appointment.confirmed","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.confirmed/operations/appointment.confirmed","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"An appointment has been confirmed","description":"An appointment has been confirmed"}}}]},{"label":"appointment.rescheduled","type":"group","link":"/apis/webhooks/asyncapi/channels/appointment.rescheduled","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.rescheduled","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"appointment.rescheduled"}},"items":[{"label":"An appointment has been rescheduled","type":"link","link":"/apis/webhooks/asyncapi/channels/appointment.rescheduled/operations/appointment.rescheduled","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.rescheduled/operations/appointment.rescheduled","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"An appointment has been rescheduled","description":"An appointment has been rescheduled"}}}]},{"label":"appointment.cancelled","type":"group","link":"/apis/webhooks/asyncapi/channels/appointment.cancelled","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.cancelled","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"appointment.cancelled"}},"items":[{"label":"An appointment has been cancelled","type":"link","link":"/apis/webhooks/asyncapi/channels/appointment.cancelled/operations/appointment.cancelled","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.cancelled/operations/appointment.cancelled","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"An appointment has been cancelled","description":"An appointment has been cancelled"}}}]},{"label":"appointment.booking-failed","type":"group","link":"/apis/webhooks/asyncapi/channels/appointment.booking-failed","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.booking-failed","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"appointment.booking-failed"}},"items":[{"label":"An appointment booking failed to confirm in the EHR","type":"link","link":"/apis/webhooks/asyncapi/channels/appointment.booking-failed/operations/appointment.booking-failed","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.booking-failed/operations/appointment.booking-failed","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"An appointment booking failed to confirm in the EHR","description":"An appointment booking failed to confirm in the EHR"}}}]},{"label":"appointment.cancel-failed","type":"group","link":"/apis/webhooks/asyncapi/channels/appointment.cancel-failed","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.cancel-failed","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"appointment.cancel-failed"}},"items":[{"label":"An appointment cancellation failed to confirm in the EHR","type":"link","link":"/apis/webhooks/asyncapi/channels/appointment.cancel-failed/operations/appointment.cancel-failed","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.cancel-failed/operations/appointment.cancel-failed","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"An appointment cancellation failed to confirm in the EHR","description":"An appointment cancellation failed to confirm in the EHR"}}}]},{"label":"appointment.reschedule-failed","type":"group","link":"/apis/webhooks/asyncapi/channels/appointment.reschedule-failed","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.reschedule-failed","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"appointment.reschedule-failed"}},"items":[{"label":"An appointment reschedule failed to confirm in the EHR","type":"link","link":"/apis/webhooks/asyncapi/channels/appointment.reschedule-failed/operations/appointment.reschedule-failed","routeSlug":"/apis/webhooks/asyncapi/channels/appointment.reschedule-failed/operations/appointment.reschedule-failed","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"An appointment reschedule failed to confirm in the EHR","description":"An appointment reschedule failed to confirm in the EHR"}}}]},{"label":"form-submission.created","type":"group","link":"/apis/webhooks/asyncapi/channels/form-submission.created","routeSlug":"/apis/webhooks/asyncapi/channels/form-submission.created","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"form-submission.created"}},"items":[{"label":"A form submission has been created","type":"link","link":"/apis/webhooks/asyncapi/channels/form-submission.created/operations/form-submission.created","routeSlug":"/apis/webhooks/asyncapi/channels/form-submission.created/operations/form-submission.created","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"A form submission has been created","description":"A form submission has been created"}}}]},{"label":"prescription.issued","type":"group","link":"/apis/webhooks/asyncapi/channels/prescription.issued","routeSlug":"/apis/webhooks/asyncapi/channels/prescription.issued","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"prescription.issued"}},"items":[{"label":"A prescription has been issued","type":"link","link":"/apis/webhooks/asyncapi/channels/prescription.issued/operations/prescription.issued","routeSlug":"/apis/webhooks/asyncapi/channels/prescription.issued/operations/prescription.issued","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"A prescription has been issued","description":"A prescription has been issued"}}}]},{"label":"patient.added-to-sequence","type":"group","link":"/apis/webhooks/asyncapi/channels/patient.added-to-sequence","routeSlug":"/apis/webhooks/asyncapi/channels/patient.added-to-sequence","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"patient.added-to-sequence"}},"items":[{"label":"A patient has been added to a sequence","type":"link","link":"/apis/webhooks/asyncapi/channels/patient.added-to-sequence/operations/patient.added-to-sequence","routeSlug":"/apis/webhooks/asyncapi/channels/patient.added-to-sequence/operations/patient.added-to-sequence","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"A patient has been added to a sequence","description":"A patient has been added to a sequence"}}}]},{"label":"write-to-record.succeeded","type":"group","link":"/apis/webhooks/asyncapi/channels/write-to-record.succeeded","routeSlug":"/apis/webhooks/asyncapi/channels/write-to-record.succeeded","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"write-to-record.succeeded"}},"items":[{"label":"A WriteToRecord job finished successfully","type":"link","link":"/apis/webhooks/asyncapi/channels/write-to-record.succeeded/operations/write-to-record.succeeded","routeSlug":"/apis/webhooks/asyncapi/channels/write-to-record.succeeded/operations/write-to-record.succeeded","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"A WriteToRecord job finished successfully","description":"A WriteToRecord job finished successfully"}}}]},{"label":"write-to-record.failed","type":"group","link":"/apis/webhooks/asyncapi/channels/write-to-record.failed","routeSlug":"/apis/webhooks/asyncapi/channels/write-to-record.failed","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"write-to-record.failed"}},"items":[{"label":"A WriteToRecord job failed permanently","type":"link","link":"/apis/webhooks/asyncapi/channels/write-to-record.failed/operations/write-to-record.failed","routeSlug":"/apis/webhooks/asyncapi/channels/write-to-record.failed/operations/write-to-record.failed","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"A WriteToRecord job failed permanently","description":"A WriteToRecord job failed permanently"}}}]},{"label":"ehr.health_status.healthy","type":"group","link":"/apis/webhooks/asyncapi/channels/ehr.health_status.healthy","routeSlug":"/apis/webhooks/asyncapi/channels/ehr.health_status.healthy","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"ehr.health_status.healthy"}},"items":[{"label":"The EHR connection for a practice group has become healthy","type":"link","link":"/apis/webhooks/asyncapi/channels/ehr.health_status.healthy/operations/ehr.health_status.healthy","routeSlug":"/apis/webhooks/asyncapi/channels/ehr.health_status.healthy/operations/ehr.health_status.healthy","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"The EHR connection for a practice group has become healthy","description":"The EHR connection for a practice group has become healthy"}}}]},{"label":"ehr.health_status.unhealthy","type":"group","link":"/apis/webhooks/asyncapi/channels/ehr.health_status.unhealthy","routeSlug":"/apis/webhooks/asyncapi/channels/ehr.health_status.unhealthy","httpVerb":"channel","badges":[],"metadata":{"seo":{"title":"ehr.health_status.unhealthy"}},"items":[{"label":"The EHR connection for a practice group has become unhealthy","type":"link","link":"/apis/webhooks/asyncapi/channels/ehr.health_status.unhealthy/operations/ehr.health_status.unhealthy","routeSlug":"/apis/webhooks/asyncapi/channels/ehr.health_status.unhealthy/operations/ehr.health_status.unhealthy","httpVerb":"send","badges":[],"metadata":{"seo":{"title":"The EHR connection for a practice group has become unhealthy","description":"The EHR connection for a practice group has become unhealthy"}}}]}],"icon":"solid satellite-dish"}]}