Skip to main content
WEBHOOK

Body

application/json
data
Appointment · object
required

Appointments represent scheduled visits for patients at a clinic. Each appointment is uniquely associated with a patient and can include details about the visit, such as the reason for the appointment, duration, and any special instructions. If a client has scheduled two patients, this will be represented as two separate appointments in our system.

Unlike select legacy PIMS systems that create additional appointments for pickup and dropoff events, our appointment object includes both pickup and dropoff times when applicable, streamlining the scheduling process. This means a surgery would be represented as a single appointment with both check-in and check-out times, rather than as multiple separate appointments.

type
string
required

The event type identifier.

Allowed value: "appointment.completed"

Response

200

Webhook received