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.

Lead

lead.converted_to_patient
A Lead was converted to a Patient.
lead.created
A Lead was created.
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.

Refund

refund.created
A Refund was created.