Webhook event

`patient_connection.created`

A Patient was created for or connected to an Organization.

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
  - clinician_idstring | null · uuidrequired
    The Clinician associated with this registration, when one is assigned.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - gp_statusstring | nullrequired
    Whether this Organization has recorded a GP for the Patient. has_gp means a GP PatientConnection is expected. no_gp_required means the Patient does not need a GP. none_or_omitted means no GP has been recorded.
    Allowed values: none_or_omitted | has_gp | no_gp_required | null
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - is_activebooleanrequired
    Whether the Patient registration is active.
  - linksobjectrequired
    URLs to related resources.
    - patientstring · urirequired
      The full URL of a related resource.
    - payorstring | null · urirequired
      The full URL of a related resource.
  - objectanyrequired
    Discriminator value emitted at object.
  - organizationobjectrequired
    - address_line_1string | nullrequired
      The primary address line of the organization.
    - address_line_2string | nullrequired
      The secondary address line of the organization.
    - citystring | nullrequired
      The city in the organization'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 organization's postal address.
    - created_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
    - currencystring | nullrequired
      The ISO 4217 currency code used by the organization. Must be one of chf, eur, gbp, or usd. Null when this Organization is returned from GET /v1/organizations or nested on a PatientConnection.
    - emailstring | null · emailrequired
      The contact email address of the organization. Null when this Organization is returned from GET /v1/organizations or nested on a PatientConnection.
    - formatted_addressstring | nullrequired
      The single-line address of the organization, formatted for display.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - namestringrequired
      The display name of the organization, for example Acme Healthcare.
    - objectanyrequired
      Discriminator value emitted at object.
    - organization_typestring | nullrequired
      The kind of organization. Use gp_practice when attaching a GP.
      Allowed values: consultant | gp_practice | hospital | laboratory | legal | other | pharmacy | private_practice | null
    - phonestring | nullrequired
      The formatted contact phone number of the organization. Null when this Organization is returned from GET /v1/organizations or nested on a PatientConnection.
    - postcodestring | nullrequired
      The postal code in the organization's postal address.
    - subdomainstring | nullrequired
      The URL-safe subdomain that identifies the organization. Null when this Organization is returned from GET /v1/organizations or nested on a PatientConnection.
    - time_zonestring | nullrequired
      The IANA time zone used to interpret scheduling dates and display appointment times. Always Europe/London when present. Null when this Organization is returned from GET /v1/organizations or nested on a PatientConnection.
    - updated_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - organization_idstring · uuidrequired
    The Organization with which the Patient was registered.
  - patientobjectrequired
    - 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.
  - payor_idstring | null · uuidrequired
    The Payor this Organization uses as the default billing party for the Patient.
  - 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-000000000017",
      "object": "patient_connection",
      "clinician_id": "00000000-0000-4000-8000-000000000002",
      "created_at": "2026-01-01T09:00:00Z",
      "gp_status": "has_gp",
      "is_active": true,
      "links":  … }
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004",
        "payor": null
      },
      "organization":  … }
        "id": "00000000-0000-4000-8000-000000000018",
        "object": "organization",
        "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",
        "currency": null,
        "email": null,
        "formatted_address": "1 Test Street, Test City, GB, TE1 1ST",
        "name": "High Street Surgery",
        "organization_type": "gp_practice",
        "phone": null,
        "postcode": "TE1 1ST",
        "subdomain": null,
        "time_zone": null,
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "organization_id": "00000000-0000-4000-8000-000000000018",
      "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_id": null,
      "updated_at": "2026-01-01T09:00:00Z"
    }
  },
  "developer_platform_project_id": null,
  "livemode": false,
  "source": "dashboard",
  "type": "patient_connection.created"
}

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