Properties

event_type
const string
required

Constant: labtest.appointment.update

data
ClientFacingAppointment
required
id
string
required
user_id
string
required
order_id
string
required
address
USAddress
required
first_line
string
required
second_line
string | null
city
string
required
state
string
required
zip_code
string
required
unit
string | null

[⚠️ Deprecated] Deprecated. Use second_line instead to provide the unit number. Subject to removal after 20 Nov 2023.

location
LngLat
required
lng
number
required
lat
number
required
start_at
string
required

Time is in UTC

end_at
string
required

Time is in UTC

iana_timezone
string
required
type
AppointmentType
required
provider
AppointmentProvider
required
status
AppointmentStatus
required
provider_id
string
required
can_reschedule
boolean
required
event_status
AppointmentEventStatus
required
event_data
object | null
events
ClientFacingAppointmentEvent[]
required
created_at
string
required
status
AppointmentEventStatus
required
data
object | null

Examples

{
  "event_type": "labtest.appointment.update",
  "data": {
    "id": "c807cf21-34f1-48f9-8a52-53dcd58491c6",
    "user_id": "5b43dca0-641d-482c-8b03-aa287ee4d0ec",
    "order_id": "e847d7b9-6079-4a83-9197-11931a3cb8fd",
    "address": {
      "first_line": "123 Main St.",
      "second_line": "Apt. 208",
      "city": "San Francisco",
      "state": "CA",
      "zip_code": "91189",
      "country": "United States"
    },
    "location": {
      "lng": -122.4194155,
      "lat": 37.7749295
    },
    "start_at": "2022-01-01T00:00:00",
    "end_at": "2022-01-01T00:00:00",
    "iana_timezone": "America/New_York",
    "type": "phlebotomy",
    "provider": "getlabs",
    "status": "confirmed",
    "event_status": "scheduled",
    "provider_id": "123",
    "can_reschedule": true,
    "event_data": {
      "description": "Metadata field containing provider specific data, like cancellation reason or origin"
    },
    "events": [
      {
        "created_at": "2022-01-01T00:00:00Z",
        "data": null,
        "status": "scheduled"
      },
      {
        "created_at": "2022-01-02T00:00:00Z",
        "data": null,
        "status": "completed"
      }
    ]
  }
}