{
  "event_id": "66666666-6666-6666-6666-666666666666",
  "event_name": "notification.status_changed",
  "referral_id": "22222222-2222-2222-2222-222222222222",
  "status": "delivered",
  "changes": {
    "status": [
      "sent",
      "delivered"
    ]
  },
  "notification": {
    "id": "44444444-4444-4444-4444-444444444444",
    "channel": "sms",
    "notification_type": "hard_confirmation_to_patient",
    "status": "delivered",
    "created_at": "2026-09-21T18:00:00Z",
    "updated_at": "2026-09-21T18:00:08Z",
    "visit_id": "11111111-1111-1111-1111-111111111111"
  },
  "occurred_at": "2026-09-21T18:00:08Z"
}

Referral status

Notification status changed

Sent when an email or SMS notification is created or its delivery status changes. This event is metadata-only and never includes recipient details or message content.

Configure an HTTPS webhook URL and ask Scan to enable notification webhooks for your account. Delivery is at least once; deduplicate using event_id. Your endpoint must return HTTP 2xx.

Request headers

Header	Value
Content-Type	application/json
User-Agent	Scan.com-Webhook/1.0
X-Scan-Event	notification.status_changed
X-Scan-Timestamp	Unix timestamp used in the signature
X-Scan-Signature	`v1=` followed by the HMAC-SHA256 digest

Verify the signature by computing HMAC-SHA256 with your signing secret over "{timestamp}.{raw_body}", using the exact request bytes.

WEBHOOK

notificationStatusChanged

{
  "event_id": "66666666-6666-6666-6666-666666666666",
  "event_name": "notification.status_changed",
  "referral_id": "22222222-2222-2222-2222-222222222222",
  "status": "delivered",
  "changes": {
    "status": [
      "sent",
      "delivered"
    ]
  },
  "notification": {
    "id": "44444444-4444-4444-4444-444444444444",
    "channel": "sms",
    "notification_type": "hard_confirmation_to_patient",
    "status": "delivered",
    "created_at": "2026-09-21T18:00:00Z",
    "updated_at": "2026-09-21T18:00:08Z",
    "visit_id": "11111111-1111-1111-1111-111111111111"
  },
  "occurred_at": "2026-09-21T18:00:08Z"
}

Body

application/json

Metadata-only notification status event sent to your webhook URL

event_id

string<uuid>

required

Stable event identifier reused for every delivery retry

event_name

enum<string>

required

Available options:

notification.status_changed

referral_id

string<uuid>

required

status

string

required

Example:

"delivered"

changes

object

required

Show child attributes

notification

object

required

Delivery metadata for an email or SMS associated with a referral

Show child attributes

occurred_at

string<date-time>

required

Response

200

Return any 2xx response to acknowledge the event

Get started

Launch

Patient journey

Referral status

Lines of business

Notification status changed

Body

Response