Webhook event

`booking.arrived`

A Patient arrived for a Booking.

Payload schema

api_versionanyrequired
contextobject
Present only when source is api. Identifies the acting project and API key.
- developer_platform_api_key_idstring | null · uuid
- developer_platform_project_idstring | null · uuid
created_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
dataobjectrequired
- objectobjectrequired
  - canceled_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - cancellation_informationstring | nullrequired
    Additional notes recorded with the cancellation.
  - cancellation_reasonstring | nullrequired
    The reason the Booking was canceled. Required by Organizations that enforce cancellation reasons.
    Allowed values: abusive_behavior | booked_in_error | childcare_issues | clinician_annual_leave | clinician_emergency | clinician_schedule_change | colleague_unavailable | double_booked | duplicate_booking | equipment_issue | facility_unavailable | failed_to_pay_in_advance | family_emergency_illness | fear_or_anxiety | financial_concerns | financial_requirements_not_met | forgot_to_attend | insurance_company_not_permitted | insurance_coverage_issues | insurance_verification_failed | language_barrier | medication_interference | no_longer_required | no_response_to_recall | other | patient_deceased | patient_not_permitted | personal_emergency_illness | pre_booking_steps_not_completed | professional_discretion | referral_not_provided | relocated | rescheduled | scheduling_conflict | staff_issue | switched_to_another_clinician | symptoms_resolved | too_unwell | transportation_issues | unable_failed_to_prepare_for_booking | unknown | weather_conditions | wrong_clinician | wrong_location | wrong_service_type | null
  - cancellation_sourcestring | nullrequired
    Who canceled the Booking. API cancellations use api.
    Allowed values: api | app | automation | patient | staff_member | null
  - clinicianobject | nullrequired
    The clinician assigned to the booking.
    - created_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
    - display_namestringrequired
      The formatted name of the clinician, including title.
    - emailstring | null · emailrequired
      The practice contact email of the clinician within the organization.
    - first_namestring | nullrequired
      The first name of the clinician.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - last_namestring | nullrequired
      The last name of the clinician.
    - linksobjectrequired
      URLs to related resources.
      - bookingsstring · urirequired
        URL to list Bookings for this Clinician.
    - medical_specialtystring | nullrequired
      The medical specialty of the clinician, when recorded.
    - objectanyrequired
      Discriminator value emitted at object.
    - titlestring | nullrequired
      The professional or personal title of the clinician, when recorded, such as Dr.
    - updated_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - end_timestring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - information_for_patientstring | nullrequired
    The sanitized HTML shown to the patient.
  - information_for_staff_membersstring | nullrequired
    The sanitized HTML shown only to staff members.
  - is_remotebooleanrequired
    Whether the Booking takes place remotely.
  - linksobjectrequired
    URLs to related resources.
    - clinicianstring | null · urirequired
      The full URL of a related resource.
    - invoicesstring · urirequired
      The full URL of a related resource.
    - lettersstring · urirequired
      The full URL of a related resource.
    - notesstring · urirequired
      The full URL of a related resource.
    - servicestring | null · urirequired
      The full URL of a related resource.
    - test_resultsstring · urirequired
      The full URL of a related resource.
  - locationobject | nullrequired
    The location where the booking takes place, or null for a remote booking.
    - address_line_1string | nullrequired
      The primary address line of the location.
    - address_line_2string | nullrequired
      The secondary address line of the location.
    - citystring | nullrequired
      The city in the location's postal address.
    - country_codestring | nullrequired
      The ISO 3166-1 alpha-2 country code for the postal address, such as GB for the United Kingdom.
    - countystring | nullrequired
      The county or region in the location's postal address.
    - created_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
    - formatted_addressstring | nullrequired
      The single-line address of the location, formatted for display.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - namestring | nullrequired
      The display name of the location.
    - objectanyrequired
      Discriminator value emitted at object.
    - postcodestring | nullrequired
      The postal code of the location.
    - updated_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - objectanyrequired
    Discriminator value emitted at object.
  - patientobject | nullrequired
    The patient attending the booking.
    - address_line_1string | nullrequired
      The primary address line of the Patient.
    - address_line_2string | nullrequired
      The secondary address line of the Patient.
    - citystring | nullrequired
      The city in the Patient's postal address.
    - country_codestring | nullrequired
      The ISO 3166-1 alpha-2 country code for the postal address, such as GB for the United Kingdom.
    - countystring | nullrequired
      The county or region in the Patient's postal address.
    - created_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
    - creation_sourcestring | nullrequired
      How the Patient was created. api means the record was created through the Developer Platform. Read-only.
    - date_of_birthstring | null · daterequired
      The date of birth of the patient, in ISO 8601 format (YYYY-MM-DD).
    - display_namestring | nullrequired
      The formatted display name of the patient, including their title when recorded.
    - emailstring | null · emailrequired
      The email address of the patient, when recorded.
    - first_namestring | nullrequired
      The first name of the patient.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - is_opted_out_of_smsbooleanrequired
      Whether the Patient has opted out of SMS messages.
    - last_namestring | nullrequired
      The last name of the patient.
    - mobilestring | nullrequired
      The national mobile number without its country calling code.
    - mobile_country_dial_codestring | nullrequired
      The ISO 3166-1 alpha-2 country code used to derive the mobile calling code.
    - nhs_numberstring | nullrequired
      The 10-digit NHS number of the patient, without formatting.
    - objectanyrequired
      Discriminator value emitted at object.
    - phonestring | nullrequired
      The national phone number without its country calling code.
    - phone_country_dial_codestring | nullrequired
      The ISO 3166-1 alpha-2 country code used to derive the phone calling code.
    - phone_numberstring | nullrequired
      The Patient's preferred contact number, formatted for display and compatible with E.164.
    - postcodestring | nullrequired
      The postal code of the Patient.
    - sexstring | nullrequired
      The Patient's recorded sex.
      Allowed values: female | male | other | null
    - titlestring | nullrequired
      The personal title of the patient, when recorded.
    - updated_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - payorobject | nullrequired
    The payor responsible for the booking's charges.
    - address_line_1string | nullrequired
      The primary address line of the payor.
    - address_line_2string | nullrequired
      The secondary address line of the payor.
    - alternative_payor_idstring | null · uuidrequired
      The identifier of the alternative payor responsible for payment, when payor_type is alternative_payor.
    - citystring | nullrequired
      The city in the payor's postal address.
    - country_codestring | nullrequired
      The ISO 3166-1 alpha-2 country code for the postal address, such as GB for the United Kingdom.
    - countystring | nullrequired
      The county or region in the payor's postal address.
    - created_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
    - first_namestring | nullrequired
      The first name of the person responsible for payment, when applicable.
    - formatted_namestring | nullrequired
      The formatted name of the person responsible for payment.
    - formatted_payor_namestring | nullrequired
      The display name of the patient, insurer, or alternative payor responsible for payment.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - insurance_authorization_codestring | nullrequired
      The insurer's authorization code.
    - insurance_company_idstring | null · uuidrequired
      The identifier of the insurance company responsible for payment, when payor_type is insurance_company.
    - insurance_policy_end_datestring | null · daterequired
      The end date of the insurance policy, when recorded.
    - insurance_policy_numberstring | nullrequired
      The policy or membership number supplied by the insurer.
    - insurance_policy_start_datestring | null · daterequired
      The start date of the insurance policy, when recorded.
    - last_namestring | nullrequired
      The last name of the person responsible for payment, when applicable.
    - notesstring | nullrequired
      The additional payment or insurance information recorded for this payor.
    - objectanyrequired
      Discriminator value emitted at object.
    - payor_typestringrequired
      The type of party responsible for payment.
      Allowed values: patient | insurance_company | alternative_payor
    - postcodestring | nullrequired
      The postal code of the payor.
    - titlestring | nullrequired
      The personal title of the person responsible for payment, when applicable.
    - updated_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - recall_due_datestring | null · daterequired
    The date the Patient is due to return, in ISO 8601 format (YYYY-MM-DD). Present on recall Bookings. Null on diary Bookings.
  - remote_methodstring | nullrequired
    The remote consultation method. native_video uses Carebit Video.
    Allowed values: native_video | null
  - serviceobject | nullrequired
    The service being provided during the booking.
    - created_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
    - descriptionstring | nullrequired
      The description of the service shown to staff members and patients.
    - duration_minutesinteger | nullrequired
      The scheduled duration of the service, in minutes.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - is_bookable_onlinebooleanrequired
      Whether patients can book this service online in the Patient Portal.
    - namestringrequired
      The display name of the service.
    - objectanyrequired
      Discriminator value emitted at object.
    - service_variantsarrayrequired
      The bookable variants of this service.
      - itemsobject
        clinician_idstring | null · uuidrequired
        The identifier of the clinician assigned to this service variant, when the variant is clinician-specific.
        currencystring | nullrequired
        The ISO 4217 currency code used for this service variant. Must be one of chf, eur, gbp, or usd.
        descriptionstring | nullrequired
        The description of this service variant.
        idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
        linksobjectrequired
        URLs to related resources.
        clinicianstring | null · urirequired
        The full URL of a related resource.
        locationstring | null · urirequired
        The full URL of a related resource.
        location_idstring | null · uuidrequired
        The identifier of the location assigned to this service variant, when the variant is location-specific.
        net_priceinteger | nullrequired
        The net price of this service variant, before tax, in the currency's minor units.
        permits_remote_bookingsbooleanrequired
        Whether this service variant can be used for remote bookings.
    - tax_rateobject | nullrequired
      The tax rate applied to this service. Null when no tax rate is set.
      - descriptionstring | nullrequired
        The description of when the tax rate applies.
      - idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
      - percentagenumberrequired
        The tax rate as a percentage from 0 to 100.
      - titlestringrequired
        The display name of the tax rate, for example 20% VAT.
    - updated_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - service_variantsarrayrequired
    The service variants selected for the booking.
    - itemsobject
      - clinician_idstring | null · uuidrequired
        The identifier of the clinician assigned to this service variant, when the variant is clinician-specific.
      - currencystring | nullrequired
        The ISO 4217 currency code used for this service variant. Must be one of chf, eur, gbp, or usd.
      - descriptionstring | nullrequired
        The description of this service variant.
      - idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
      - linksobjectrequired
        URLs to related resources.
        clinicianstring | null · urirequired
        The full URL of a related resource.
        locationstring | null · urirequired
        The full URL of a related resource.
      - location_idstring | null · uuidrequired
        The identifier of the location assigned to this service variant, when the variant is location-specific.
      - net_priceinteger | nullrequired
        The net price of this service variant, before tax, in the currency's minor units.
      - permits_remote_bookingsbooleanrequired
        Whether this service variant can be used for remote bookings.
  - start_timestring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - statusstring | nullrequired
    The Booking's current status. Null while Carebit is creating the record.
    Allowed values: arrived | awaiting_payment | awaiting_recall | canceled | confirmed | did_not_attend | overdue_for_recall | prepared | recall_canceled | recall_expired | unconfirmed | null
  - updated_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
developer_platform_project_idstring | null · uuidrequired
The project ID whose credential caused the change. Null for dashboard events.
idstringrequired
Event identifier prefixed with evt_.
livemodebooleanrequired
false for test-event deliveries.
objectanyrequired
sourcestringrequired
Origin of the change. api means a Developer Platform mutation; dashboard means a Carebit-initiated change.
Allowed values: api | dashboard
typeanyrequired

Example

{
  "id": "evt_00000000-0000-4000-8000-000000000012",
  "object": "event",
  "api_version": "v1",
  "created_at": "2026-01-01T09:00:00Z",
  "data":  … }
    "object":  … }
      "id": "00000000-0000-4000-8000-000000000001",
      "object": "booking",
      "canceled_at": null,
      "cancellation_information": null,
      "cancellation_reason": null,
      "cancellation_source": null,
      "clinician":  … }
        "id": "00000000-0000-4000-8000-000000000002",
        "object": "clinician",
        "created_at": "2026-01-01T09:00:00Z",
        "display_name": "Dr Ada Lovelace",
        "email": "ada.lovelace@example.invalid",
        "first_name": "Ada",
        "last_name": "Lovelace",
        "links":  … }
          "bookings": "https://api.carebit.co/v1/bookings?clinician_id=00000000-0000-4000-8000-000000000002"
        },
        "medical_specialty": "General Medicine",
        "title": "Dr",
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "created_at": "2026-01-01T09:00:00Z",
      "end_time": "2026-01-01T10:30:00Z",
      "information_for_patient": "This is a test booking. Please ignore.",
      "information_for_staff_members": "This is a test booking.",
      "is_remote": false,
      "links":  … }
        "clinician": "https://api.carebit.co/v1/clinicians/00000000-0000-4000-8000-000000000002",
        "invoices": "https://api.carebit.co/v1/invoices?booking_id=00000000-0000-4000-8000-000000000001",
        "letters": "https://api.carebit.co/v1/letters?booking_id=00000000-0000-4000-8000-000000000001",
        "notes": "https://api.carebit.co/v1/notes?booking_id=00000000-0000-4000-8000-000000000001",
        "service": "https://api.carebit.co/v1/services/00000000-0000-4000-8000-000000000005",
        "test_results": "https://api.carebit.co/v1/test_results?booking_id=00000000-0000-4000-8000-000000000001"
      },
      "location":  … }
        "id": "00000000-0000-4000-8000-000000000003",
        "object": "location",
        "address_line_1": "1 Test Street",
        "address_line_2": null,
        "city": "Test City",
        "country_code": "GB",
        "county": "Testshire",
        "created_at": "2026-01-01T09:00:00Z",
        "formatted_address": "1 Test Street, Test City, GB, TE1 1ST",
        "name": "Test Location",
        "postcode": "TE1 1ST",
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "patient":  … }
        "id": "00000000-0000-4000-8000-000000000004",
        "object": "patient",
        "address_line_1": "1 Test Street",
        "address_line_2": null,
        "city": "Test City",
        "country_code": "GB",
        "county": "Testshire",
        "created_at": "2026-01-01T09:00:00Z",
        "creation_source": "api",
        "date_of_birth": "1970-01-01",
        "display_name": "Ms Test Patient",
        "email": "test.patient@example.invalid",
        "first_name": "Test",
        "is_opted_out_of_sms": false,
        "last_name": "Patient",
        "mobile": "7700900123",
        "mobile_country_dial_code": "GB",
        "nhs_number": "9990000000",
        "phone": "1234567890",
        "phone_country_dial_code": "GB",
        "phone_number": "+441234567890",
        "postcode": "TE1 1ST",
        "sex": "female",
        "title": "Ms",
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "payor": null,
      "recall_due_date": null,
      "remote_method": null,
      "service":  … }
        "id": "00000000-0000-4000-8000-000000000005",
        "object": "service",
        "created_at": "2026-01-01T09:00:00Z",
        "description": "Test consultation service.",
        "duration_minutes": 30,
        "is_bookable_online": true,
        "name": "Test consultation",
        "service_variants":  … ]
           … }
            "id": "00000000-0000-4000-8000-000000000006",
            "clinician_id": "00000000-0000-4000-8000-000000000002",
            "currency": "GBP",
            "description": "Standard consultation variant.",
            "links":  … }
              "clinician": "https://api.carebit.co/v1/clinicians/00000000-0000-4000-8000-000000000002",
              "location": "https://api.carebit.co/v1/locations/00000000-0000-4000-8000-000000000003"
            },
            "location_id": "00000000-0000-4000-8000-000000000003",
            "net_price": 6200,
            "permits_remote_bookings": false
          }
        ],
        "tax_rate": null,
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "service_variants":  … ]
         … }
          "id": "00000000-0000-4000-8000-000000000006",
          "clinician_id": "00000000-0000-4000-8000-000000000002",
          "currency": "GBP",
          "description": "Standard consultation variant.",
          "links":  … }
            "clinician": "https://api.carebit.co/v1/clinicians/00000000-0000-4000-8000-000000000002",
            "location": "https://api.carebit.co/v1/locations/00000000-0000-4000-8000-000000000003"
          },
          "location_id": "00000000-0000-4000-8000-000000000003",
          "net_price": 6200,
          "permits_remote_bookings": false
        }
      ],
      "start_time": "2026-01-01T10:00:00Z",
      "status": "arrived",
      "updated_at": "2026-01-01T09:00:00Z"
    }
  },
  "developer_platform_project_id": null,
  "livemode": false,
  "source": "dashboard",
  "type": "booking.arrived"
}

Prefer plain text? Append ?format=md or send Accept: text/markdown to receive this page as raw Markdown.