Skip to main content
event_type
enum<string>
required
Available options:
labtest.appointment.created,
labtest.appointment.updated
user_id
string<uuid>
required
client_user_id
string<uuid>
required
team_id
string<uuid>
required
data
ClientFacingAppointment · object
required
Example:
{
"address": {
"access_notes": "Gate code #1234, use side entrance",
"city": "San Francisco",
"country": "United States",
"first_line": "123 Main St.",
"second_line": "Apt. 208",
"state": "CA",
"zip_code": "91189"
},
"appointment_notes": "Please bring photo ID",
"can_reschedule": true,
"end_at": "2022-01-01T00:00:00",
"event_data": {
"description": "Metadata field containing provider specific data, like cancellation reason or origin"
},
"event_status": "scheduled",
"events": [
{
"created_at": "2022-01-01T00:00:00Z",
"status": "scheduled"
},
{
"created_at": "2022-01-02T00:00:00Z",
"status": "completed"
}
],
"external_id": "ext-123",
"iana_timezone": "America/New_York",
"id": "8bc2e312-3123-497a-8102-5ea157e76d26",
"location": { "lat": 37.7749295, "lng": -122.4194155 },
"order_id": "a5423fa1-a376-4be7-8a8f-61bbbdcaed84",
"order_transaction_id": "bd0b0e3d-5093-436e-8cfd-13ac78f0606f",
"provider": "getlabs",
"provider_id": "123",
"start_at": "2022-01-01T00:00:00",
"status": "confirmed",
"type": "phlebotomy",
"user_id": "c25b6aa6-95f9-4198-8cb5-b128b5ecdde8"
}