Event-driven integrations

Webhook events

Every webhook is signed with a shared secret and delivered with exponential backoff for up to three days. See the webhook signature guide for verification code samples.

Booking

booking.arrived
A Patient arrived for a Booking.
booking.canceled
A Booking was canceled.
booking.confirmed
A Booking was confirmed.
booking.did_not_attend
A Booking was marked as did not attend.
booking.end_time_reached
A Booking reached its scheduled end time.
booking.updated
A Booking's schedule, service, or metadata changed.

Digital form response

digital_form_response.completed
A Patient completed a DigitalFormResponse.

Expirable file

expirable_file.available
An ExpirableFile is available to download.

Invoice

invoice.finalized
An Invoice was finalized.
invoice.overdue
An Invoice became overdue.
invoice.paid
An Invoice's status changed to paid.
invoice.sent
An Invoice was sent to the payor.
invoice.settled
An Invoice was settled with no outstanding balance.

Lead

lead.converted_to_patient
A Lead was converted to a Patient.
lead.created
A Lead was created.
lead.form_response_submitted
A Lead form was submitted.
lead.stage_changed
A Lead moved between pipeline stages.
lead.updated
A Lead's profile or lifecycle data changed.

List

list.member_added
A Patient was added to a List.
list.member_removed
A Patient was removed from a List.

Patient connection

patient_connection.created
A Patient was created for or connected to an Organization.

Patient connection request

patient_connection_request.created
A PatientConnectionRequest was created after POST /v1/patients matched one or more unconnected Patients.
patient_connection_request.denied
A PatientConnectionRequest was denied.
patient_connection_request.expired
A pending PatientConnectionRequest expired after 30 days without a staff action.
patient_connection_request.granted
A PatientConnectionRequest was granted.

Payment

payment.paid
A Payment was recorded as paid.

Quote

quote.accepted
A Quote was accepted and an Invoice was created.
quote.created
A Quote was created.

Refund

refund.created
A Refund was created.
refund.failed
A Refund to the original payment method failed.