Ovianta Developers

note.created

The agent left a note for the clinic's staff.

Sent when an agent leaves a note: the patient asked for something the agent cannot do, such as a call back from reception, a question about a bill, or a request for a doctor. The note carries what reception needs to act: who, how to reach them, why, and the fields the clinic asked the agent to fill in.

Notes come from phone calls, the website widget and WhatsApp. channel says which: voice for the first two, whatsapp for the last.

Note fields

note.fields lists every field the clinic set up for this agent, in the agent's order, including the ones this note left empty (value: null). Map them on key, which never changes; label is the name the clinic gave the field and can be renamed.

Payload

data fields (version 1)

Prop

Type

Example body

POST {your URL} x-ovianta-event: note.created
{
  "event": "note.created",
  "eventId": "evt_3f9c2a7d41b8e6c05a1d9e2f",
  "version": 1,
  "sentAt": "2026-09-01T11:39:45.000+02:00",
  "attempt": 1,
  "data": {
    "note": {
      "id": "68f0c2a1b4e5d6f7a8b9c0d1",
      "createdAt": "2026-09-01T11:39:30.000+02:00",
      "callId": "68f0c1d2e3f4a5b6c7d8e9f0",
      "patientName": "Marta Ruiz",
      "phone": "+34654654654",
      "callReason": "Wants to know whether her insurance covers cataract surgery.",
      "fields": [
        {
          "key": "insurance",
          "label": "Insurance",
          "value": "Adeslas"
        },
        {
          "key": "urgent",
          "label": "Urgent",
          "value": false
        },
        {
          "key": "preferred_time",
          "label": "Best time to call back",
          "value": null
        }
      ]
    },
    "channel": "voice",
    "agent": {
      "id": "6801234abcde5f6789012345",
      "name": "Reception",
      "type": "appointments_booking"
    },
    "center": {
      "id": "6801234abcde5f6789099999",
      "name": "Sede Centro",
      "externalId": "1"
    }
  }
}

On this page