Tour request example

Prev

An example tour.create request for a tour or consultation request (category 20 onsite, category 21 remote). All names, contact details and messages are made up.

Who can use it: enquiry webhooks are available to Enhanced and Platinum subscribers. See Enquiry Webhooks Overview.

The fields outside categorySpecificData are the same for every type and are described in Enquiry Webhook Request. Every field listed below is always sent; if the information was not collected, its value is null.

Fields

Sent as tour.create when someone requests an onsite tour or consultation (category 20) or a remote one (category 21). bodycontent is an HTML summary of the booking.

FieldTypeDescription
bookingDatestringThe requested date, written out, for example Tuesday 10th November 2026.
bookingDateTimestringThe requested date and time in ISO 8601 format with the UK offset, for example 2026-11-10T14:00:00Z in winter or 2026-06-01T10:30:00+01:00 in summer.
bookingTimestringThe requested time, 24-hour HH:mm.
bookingTypestringOnsite Tour/Consultation or Remote Tour/Consultation.
commentstring or nullThe enquirer's comments.
whoIsNeedOfCarestring or nullWho needs care, from the enquirer's point of view. One of the listed values below.
careNeededTypestring or nullThe type of care needed. One of the listed values below.
howSoonTypestring or nullHow soon care is needed. One of the listed values below.
stayLengthTypestring or nullWhether the stay is long-term or short-term. One of the listed values below.
fundingTypestring or nullHow the care will be paid for. One of the listed values below.

Example request

{
  "type": "tour.create",
  "timestamp": "2026-11-03T10:26:10.344Z",
  "data": {
    "id": 12345681,
    "category": {
      "id": 20,
      "name": "Onsite Tour/Consultation Request"
    },
    "member": {
      "id": "123456",
      "name": "Example Care Home",
      "postcode": "AB1 2CD"
    },
    "group": {
      "id": "654321",
      "name": "Example Care Group",
      "postcode": "AB1 2CD"
    },
    "emailto": "manager@example.com",
    "emailfrom": "example@example.com",
    "entrydate": "2026-11-03T10:26:07.000Z",
    "bodycontent": "<p><strong>Booking Details</strong><br><br><strong>First Name:</strong> Example<br><br><strong>Last Name:</strong> Name<br><br><strong>Email Address:</strong> example@example.com<br><br><strong>Contact Number:</strong> 01234 567890<br><br><strong>Preferred Date & Time:</strong>Tuesday 10th November 2026 at 14:00<br><br><strong>Who is need of care:</strong> A parent<br><br><strong>Type of care:</strong> Older person residential<br><br><strong>How soon is care needed:</strong> 1 - 3 months<br><br><strong>Length of stay:</strong> Permanent/Long-term<br><br><strong>Type of funding:</strong> Self funding (Private)<br><br><strong>Comments:</strong><br>Example message text.</p>",
    "firstname": "Example",
    "surname": "Name",
    "address1": null,
    "address2": null,
    "address3": null,
    "town": null,
    "postcode": null,
    "telephone": "01234 567890",
    "isAnonymised": "No",
    "categorySpecificData": {
      "bookingDate": "Tuesday 10th November 2026",
      "bookingDateTime": "2026-11-10T14:00:00Z",
      "bookingTime": "14:00",
      "bookingType": "Onsite Tour/Consultation",
      "comment": "Example message text.",
      "whoIsNeedOfCare": "A parent",
      "careNeededType": "Older person residential",
      "howSoonType": "1 - 3 months",
      "stayLengthType": "Permanent/Long-term",
      "fundingType": "Self funding (Private)"
    }
  }
}

Listed values

These fields contain one of the values below, or null. N/A can also appear, mainly on call enquiries. We may add values in future, so make sure your system accepts values it does not recognise.

whoIsNeedOfCare

  • Myself
  • A parent
  • A partner
  • Another family member
  • A friend
  • A client

careNeededType

  • Older person residential
  • Older person residential dementia
  • Older person nursing
  • Older person nursing dementia
  • Other types of care
  • Not sure

howSoonType

  • Immediately (1 day - 1 week)
  • 1 week - 1 month
  • 1 - 3 months
  • 3 - 6 months
  • 6 months +

stayLengthType

  • Permanent/Long-term
  • Respite/Short-term

fundingType

  • Self funding (Private)
  • Local Authority with Top-up
  • Local Authority
  • NHS Continuing Healthcare (CHC)
  • Not sure