Patient webhook

What is a patient webhook?

The patient webhook is used when we have some new information about a patient referred to the site. Patiro will POST the details as a JSON to the webhook URL that you specify. This allows you to build applications treating Patiro as a data source.

Patient webhook data

An example full JSON document that would be sent to your webhook endpoint is below. Some more interesting fields are described here:

• eventType - one of the events listed here
• caregiver - the person responsible for the patient. null if there is no caregiver.
  • caregiver.type - can be either "Parent" or "Guardian"

{
  "eventId": "bf53700f-2f48-4034-af11-08de8be82d24",
  "eventType": "PatientUpdated",
  "timestamp": "2026-03-27T10:04:03.4247725",
  "data": {
    "id": "330276",
    "irtId": "AB-123",
    "assignedToSiteAt": "2026-03-27T10:04:03.2008489",
    "fullName": "Example Name",
    "email": "patient@example.com",
    "phoneNumber": "+1 234-567-8901",
    "caregiver": {
      "fullName": "Example Caregiver",
      "type": "Guardian"
    },
    "language": {
      "name": "English",
      "code": "en"
    },
    "country": {
      "name": "United States",
      "code": "US"
    },
    "state": {
      "name": "California",
      "code": "CA"
    },
    "city": "Townsville",
    "zipCode": "AB123456",
    "sex": "Male",
    "birthdate": "1955-08-20",
    "weightInKg": 72,
    "heightInCm": 180
  }
}

Events

There are multiple events that can trigger this webhook. You can select which ones should be sent to your webhook endpoint.

• PatientRevealed - the contact details of the patient have been revealed
• PatientUpdated - patient data has been updated, e.g. new address, new IRT id

Reveal patient contact

The webhook events are only triggered if the patient contact has been revealed. Meaning that the first webhook event you will receive for each patient is PatientRevealed. The patient contact can be revealed by the site users logged in on the platform.