Webhook event

`lead.updated`

A Lead's profile or lifecycle data changed.

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
  - address_line_1string | nullrequired
    The primary address line of the lead.
  - address_line_2string | nullrequired
    The secondary address line of the lead.
  - attachmentsarrayrequired
    The files attached to the lead.
    - itemsobject
      - download_urlstring | null · urirequired
        The short-lived signed download URL for the attachment. Null while the malware scan is not complete.
      - filenamestring | nullrequired
        The original filename of the attachment.
      - idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - citystring | nullrequired
    The city in the lead's postal address.
  - clinicianobject | nullrequired
    The clinician the lead is assigned to, when recorded.
    - 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.
  - 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 lead'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 Lead 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 lead, in ISO 8601 format (YYYY-MM-DD).
  - display_namestring | nullrequired
    The formatted display name of the lead, including their title when recorded.
  - emailstring | null · emailrequired
    The contact email address of the lead.
  - first_namestringrequired
    The first name of the lead.
  - gdpr_consent_granted_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - gdpr_consent_withdrawn_atstring | 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.
  - internal_notesstring | nullrequired
    Internal notes shown in the Notes box next to presenting problem on the Carebit lead enquiry screen. Distinct from referral_notes.
  - is_converted_to_patientbooleanrequired
    Whether the lead has been converted to a patient. Read-only.
  - is_lostbooleanrequired
    Whether the lead has been marked as lost. Read-only.
  - is_opted_out_of_smsbooleanrequired
    Whether the lead has opted out of SMS communication.
  - is_signed_up_to_newslettersbooleanrequired
    Whether the lead has signed up to receive newsletters.
  - last_namestringrequired
    The last name of the lead.
  - lead_typestringrequired
    Whether the record is a patient inquiry or a referral.
    Allowed values: inquiry | referral
  - linksobjectrequired
    URLs to related resources. remote_file_import_batch is present on create responses when at least one attachment was submitted.
    - clinicianstring | null · urirequired
      The full URL of a related resource.
    - remote_file_import_batchstring · uri
      The full URL of a related resource.
    - selfstring · urirequired
      The full URL of a related resource.
    - servicestring | null · urirequired
      The full URL of a related resource.
  - mobilestring | nullrequired
    The mobile phone number of the lead, without the country dial code.
  - mobile_country_dial_codestring | nullrequired
    The ISO 3166-1 alpha-2 country code that selects the international dial code for mobile, for example GB selects +44.
  - objectanyrequired
    Discriminator value emitted at object.
  - organization_privacy_policy_consent_granted_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - patient_idstring | null · uuidrequired
    The identifier of the Patient this Lead was converted to. Null until conversion. Read-only.
  - phonestring | nullrequired
    The landline phone number of the lead, without the country dial code.
  - phone_country_dial_codestring | nullrequired
    The ISO 3166-1 alpha-2 country code that selects the international dial code for phone, for example GB selects +44.
  - postcodestring | nullrequired
    The postal code in the lead's postal address.
  - presenting_problemstring | nullrequired
    The presenting problem the lead described. Shown next to Notes on the Carebit lead enquiry screen.
  - referral_notesstring | nullrequired
    The referral notes shown on the Carebit lead enquiry screen.
  - referral_sourcestring | nullrequired
    The referral source shown on the Carebit lead enquiry screen.
    Allowed values: consultant | embassy | family_or_friend | gp_practice | hospital | insurance_company | physiotherapist | presentation_talk | previous_patient | private_practice | search_engine | self_referral | social_media | website | other | null
  - remote_file_import_batch_idstring · uuid
    The identifier of the remote file import batch created for the submitted attachments. Present on create responses when at least one attachment was submitted.
  - serviceobject | nullrequired
    The Service the Lead is inquiring about, when recorded.
    - 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.
  - sexstring | nullrequired
    The sex of the Lead as supplied on the inquiry.
  - stageobject | nullrequired
    The current pipeline stage of the lead. Read-only; use stage_id when updating the lead.
    - 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.
    - is_conversion_stagebooleanrequired
      Whether moving a Lead into this stage can start the Organization's Lead conversion workflow.
    - is_lost_stagebooleanrequired
      Whether moving a lead into this stage marks it as lost or rejected.
    - namestringrequired
      The display name of the stage.
    - objectanyrequired
      Discriminator value emitted at object.
    - positioninteger | nullrequired
      The stage's display order within its pipeline.
    - updated_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - titlestring | nullrequired
    The personal title of the lead, when recorded.
  - 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-000000000013",
      "object": "lead",
      "address_line_1": "1 Test Street",
      "address_line_2": null,
      "attachments": [],
      "city": "Test City",
      "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"
      },
      "country_code": "GB",
      "county": "Testshire",
      "created_at": "2026-01-01T09:00:00Z",
      "creation_source": "api",
      "date_of_birth": "1990-01-01",
      "display_name": "Ms Test Lead",
      "email": "test.lead@example.invalid",
      "first_name": "Test",
      "gdpr_consent_granted_at": "2026-01-01T09:00:00Z",
      "gdpr_consent_withdrawn_at": null,
      "internal_notes": "Asked about evening appointments with Dr Smith.",
      "is_converted_to_patient": false,
      "is_lost": false,
      "is_opted_out_of_sms": false,
      "is_signed_up_to_newsletters": false,
      "last_name": "Lead",
      "lead_type": "inquiry",
      "links":  … }
        "clinician": "https://api.carebit.co/v1/clinicians/00000000-0000-4000-8000-000000000002",
        "self": "https://api.carebit.co/v1/leads/00000000-0000-4000-8000-000000000013",
        "service": "https://api.carebit.co/v1/services/00000000-0000-4000-8000-000000000005"
      },
      "mobile": "7700900123",
      "mobile_country_dial_code": "GB",
      "organization_privacy_policy_consent_granted_at": "2026-01-01T09:00:00Z",
      "patient_id": null,
      "phone": null,
      "phone_country_dial_code": null,
      "postcode": "TE1 1ST",
      "presenting_problem": "Persistent knee pain",
      "referral_notes": "Referred by Dr Patel at Riverside Medical.",
      "referral_source": "gp_practice",
      "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"
      },
      "sex": "female",
      "stage":  … }
        "id": "00000000-0000-4000-8000-000000000015",
        "object": "lead_stage",
        "created_at": "2026-01-01T09:00:00Z",
        "is_conversion_stage": false,
        "is_lost_stage": false,
        "name": "Contact made",
        "position": 5,
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "title": "Ms",
      "updated_at": "2026-01-01T09:00:00Z"
    }
  },
  "developer_platform_project_id": null,
  "livemode": false,
  "source": "dashboard",
  "type": "lead.updated"
}

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