Order Reminder Sent

Fires when Telegra sends a Complete Your Order reminder (email/SMS) to a patient via sendOrderLink. ownerEntity is the Patient; targetEntity is the Order. The eventType is order_reminder_sent.

This covers the initial reminder (order creation / manual send) and scheduled Agenda retries. Affiliates can use the payload to send their own branded reminder with the same order link.

Field guarantees

Field	Guarantee
`eventData.orderLink`	✅ Always present (v1) — same visit URL passed to the reminder template
`eventData.reminderType`	✅ Always present (v1) — `initial` or `scheduled`
`order_link`, `reminder_type`, `order_id` in v2	✅ Delivered (ORDER allowlist)

v1 payload (legacy)

{
  "_id": "event::8d367e3b-xxxx-xxxx-xxxx-3c6b7dfb804a",
  "ownerEntityModel": "Patient",
  "targetEntityModel": "Order",
  "deleted": false,
  "ownerEntity": "pat::117eb3b9-xxxx-xxxx-xxxx-9424274b5425",
  "targetEntity": "order::e5576e92-xxxx-xxxx-xxxx-3c3173a3fb82",
  "eventTitle": "Order Reminder Sent.",
  "eventDescription": "Webhook event to inform affiliate that a Complete Your Order reminder was sent to the patient.",
  "eventType": "order_reminder_sent",
  "eventData": {
    "orderLink": "https://visit.example.com/order/order::e5576e92-xxxx-xxxx-xxxx-3c3173a3fb82",
    "reminderType": "initial"
  },
  "createdAt": { "$date": "2024-08-16T12:28:38.044Z" },
  "updatedAt": { "$date": "2024-08-16T12:28:38.044Z" },
  "__v": 0
}

`eventData` field	Type	Always?	Notes
`orderLink`	string	✅	Full visit/order URL sent to the patient
`reminderType`	string	✅	`initial` (order create or manual send) or `scheduled` (Agenda retry)

v2 payload

Sanitized envelope. orderLink aliases to order_link; reminderType aliases to reminder_type. Patient name/email/phone are not included (PHI blocklist); use envelope patient_id / patient_external_id.

{
  "event_type": "order_reminder_sent",
  "event_id": "event::8d367e3b-xxxx-xxxx-xxxx-3c6b7dfb804a",
  "api_version": "2026-05-24",
  "timestamp": "2026-05-30T14:00:00.000Z",
  "affiliate_id": "aff::xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "patient_id": "pat::117eb3b9-xxxx-xxxx-xxxx-9424274b5425",
  "patient_external_id": "ext-patient-123",
  "patient_marketing_consent": false,
  "is_returning_patient": false,
  "order_id": "order::e5576e92-xxxx-xxxx-xxxx-3c3173a3fb82",
  "order_status": "started",
  "order_link": "https://visit.example.com/order/order::e5576e92-xxxx-xxxx-xxxx-3c3173a3fb82",
  "reminder_type": "initial"
}

Field	Delivered in v2	Notes
Envelope + patient identity	✅	Present on every v2 payload
`order_id`, `order_status`	✅	Resolved from the order
`order_link`	✅	Same link sent in the reminder
`reminder_type`	✅	`initial` or `scheduled`