Webhooks - Docs

Webhooks let your systems hear about changes in Avon as they happen. You add an endpoint URL, pick the events you care about (e.g. a patient is created, an appointment is cancelled, a note is signed and locked), and Avon sends a request to that URL each time one of those events happens.

You can set up as many webhook subscriptions as you need, each with its own endpoint and set of events.

Prerequisites

Part 1: Global admin access (EMR)

Only global admins can create, edit, and delete webhook subscriptions. If you don't see "Webhooks" under the Modules section in Settings, ask a global admin in your organization to set up the webhook for you or to make you a global admin.

Follow the instructions here to learn more about admin roles.

Part 2: Set up an endpoint to receive events

You'll need a publicly reachable HTTPS URL (e.g. https://your-domain.com/webhook) that accepts POST requests with a JSON body. If your endpoint also calls back into Avon's APIs, create an API key for it with access to only the data it needs.

Steps

Step 1: Create a webhook subscription (EMR)

Go to the EMR (e.g. emr.avonhealth.com)
Click on the hamburger menu on the top left corner > Settings > Webhooks (under Modules)
Click "Add New Webhook" on the top right-hand corner
A new, empty subscription is created and its settings page opens

Step 2: Set the endpoint and events (EMR)

On the subscription's settings page:

Webhook Endpoint URL: Enter the URL that should receive events (e.g. https://your-domain.com/webhook).
Subscribed Events: Check each event you want to be sent to this endpoint. Leave the rest unchecked.

All changes are autosaved, so there's no save button. Use the "Webhooks" breadcrumb at the top of the page to go back to the list.

The events you can subscribe to are:

Patients: patient.created, patient.updated
Providers, support staff, and care teams: provider.created, provider.updated, support.created, support.updated, care_team.updated
Appointments: appointment.created, appointment.completed, appointment.cancelled, appointment.rescheduled, appointment.started, appointment.pending, appointment.missed, attendee.updated
Form responses: form_response.created, form_response.updated
Care plans: care_plan.created, care_plan.updated, care_plan.signed_and_locked, care_plan.deleted
Documents: document.created, document.updated, document.signed_and_locked, document.deleted
Visit notes: note.created, note.updated, note.signed_and_locked, note.deleted
Lab results: lab_result.created
Tasks: task.created, task.updated, task.deleted
Messages: message.created, message.deleted, message_thread.created, message_thread.updated
Chart: allergy, condition, family_history, medication, vitals, and procedure events, each with .created, .updated, and .deleted
Insurance and billing: insurance_policy, insurance_claim, and invoice events, each with .created, .updated, and .deleted
Faxes: fax.signed_and_locked

Step 3: Receive events at your endpoint

Each time a subscribed event happens, Avon sends a POST request to your endpoint with a JSON body like this:

{
  "event": "appointment.cancelled",
  "created_at": "2026-10-20T15:04:05.000Z",
  "object": { "id": "appt_...", "...": "..." }
}

event: The name of the event that happened.
created_at: When the event happened.
object: The record the event is about (e.g. the appointment that was cancelled).

Every request also includes an avon-signature header, an HMAC-SHA256 hash of the request body. Use it to confirm the request came from Avon before acting on it.

Step 4: View, edit, or delete webhook subscriptions (EMR)

To view your subscriptions:

Go to the EMR (e.g. emr.avonhealth.com)
Click on the hamburger menu on the top left corner > Settings > Webhooks (under Modules)
Each subscription shows its endpoint URL and a tag for each subscribed event

To edit a subscription, click on it, then change the endpoint URL or the checked events. Changes are autosaved.

To delete a subscription:

Click the "Delete" button on the subscription's row
Click "Delete" in the confirmation modal

Avon stops sending events to that endpoint as soon as the subscription is deleted.