Webhook event

`list.member_added`

A Patient was added to a List.

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
  - created_atstring · 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.
  - linksobjectrequired
    URLs to related resources.
    - liststring · urirequired
      The full URL of a related resource.
    - patientstring | null · urirequired
      The full URL of a related resource.
    - selfstring · urirequired
      The full URL of a related resource.
  - listobject | nullrequired
    The list that contains this member.
    - clinician_idstring | null · uuidrequired
      The Clinician associated with this List, when one is set.
    - color_hexstring | nullrequired
      The display color of the List as a hex string, for example #28a745.
    - created_atstring · 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.
    - linksobjectrequired
      URLs to related resources.
      - clinicianstring | null · urirequired
        The full URL of a related resource.
      - membersstring · urirequired
        The full URL of a related resource.
      - selfstring · urirequired
        The full URL of a related resource.
    - namestringrequired
      The display name of the List.
    - notesstring | nullrequired
      Internal notes about the List.
    - objectanyrequired
      Discriminator value emitted at object.
    - updated_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - memberobject | nullrequired
    The ListMember and its resource. Null when the resource has been removed.
    - 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.
    - typestringrequired
      The kind of member. Additional values may be added later.
      Allowed values: patient
  - objectanyrequired
    Discriminator value emitted at object.
  - 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-000000000010",
      "object": "list_member",
      "created_at": "2026-01-01T09:00:00Z",
      "links":  … }
        "list": "https://api.carebit.co/v1/lists/00000000-0000-4000-8000-000000000011",
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004",
        "self": "https://api.carebit.co/v1/lists/00000000-0000-4000-8000-000000000011/members/00000000-0000-4000-8000-000000000010"
      },
      "list":  … }
        "id": "00000000-0000-4000-8000-000000000011",
        "object": "list",
        "clinician_id": "00000000-0000-4000-8000-000000000002",
        "color_hex": "#28a745",
        "created_at": "2026-01-01T09:00:00Z",
        "links":  … }
          "clinician": "https://api.carebit.co/v1/clinicians/00000000-0000-4000-8000-000000000002",
          "members": "https://api.carebit.co/v1/lists/00000000-0000-4000-8000-000000000011/members",
          "self": "https://api.carebit.co/v1/lists/00000000-0000-4000-8000-000000000011"
        },
        "name": "Test list",
        "notes": "Some notes",
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "member":  … }
        "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"
        },
        "type": "patient"
      },
      "updated_at": "2026-01-01T09:00:00Z"
    }
  },
  "developer_platform_project_id": null,
  "livemode": false,
  "source": "dashboard",
  "type": "list.member_added"
}

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